Skip to content

Commit 5b3b1fd

Browse files
committed
音声ミュート関数のコメント追加
1 parent 5edd2f0 commit 5b3b1fd

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

Sora/MediaChannel.swift

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,11 @@ public final class MediaChannel {
692692
}
693693

694694
/// MediaChannel の接続中に映像をソフトミュート有効化 / 無効化します
695-
/// 接続時のロールが sendonly または sendrecv でないとエラーを返します
695+
/// 前提条件として、
696+
/// - 接続時設定で映像が有効になっている
697+
/// - 接続時設定でロールが sendonly または sendrecv である
698+
/// - 配信ストリームが存在するかつローカル映像トラックが存在する
699+
///
696700
/// - Parameter mute: `true` で有効化、`false` で無効化
697701
/// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
698702
public func setVideoSoftMute(_ mute: Bool) -> Error? {
@@ -729,6 +733,11 @@ public final class MediaChannel {
729733
/// 内部でシリアルキューにより、操作を排他実行します。
730734
/// 同時に呼び出された場合はエラーになります。
731735
///
736+
/// 前提条件として、
737+
/// - 接続時設定で映像が有効になっている
738+
/// - 接続時設定でロールが sendonly または sendrecv である
739+
/// - 配信ストリームが存在するかつローカル映像トラックが存在する
740+
///
732741
/// 映像ハードミュートは、黒塗りフレーム状態で停止させるため映像ソフトミュート用処理を併用します。
733742
/// そのため、以下の処理を内部で実行します。
734743
///

0 commit comments

Comments
 (0)