Skip to content

Commit 6b73143

Browse files
committed
Mute 関数の Returns doc 修正
1 parent 7f0a98e commit 6b73143

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

Sora/MediaChannel.swift

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -647,8 +647,7 @@ public final class MediaChannel {
647647
/// MediaChannel の接続中にマイクをハードミュート有効化/無効化します
648648
///
649649
/// - Parameter mute: `true` で有効化、`false` で無効化
650-
/// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
651-
/// - Throws: エラー時は `SoraError.mediaChannelError` がスローされます
650+
/// - Returns: 成功した場合は `nil`、失敗した場合は `SoraError.mediaChannelError` を返します
652651
public func setAudioHardMute(_ mute: Bool) -> Error? {
653652
// 接続中か
654653
guard state == .connected else {
@@ -678,8 +677,7 @@ public final class MediaChannel {
678677
/// MediaChannel の接続中にマイクをソフトミュート有効化 / 無効化します
679678
///
680679
/// - Parameter mute: `true` で有効化、`false` で無効化
681-
/// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
682-
/// - Throws: エラー時は `SoraError.mediaChannelError` がスローされます
680+
/// - Returns: 成功した場合は `nil`、失敗した場合は `SoraError.mediaChannelError` を返します
683681
public func setAudioSoftMute(_ mute: Bool) -> Error? {
684682
// 接続中か
685683
guard state == .connected else {
@@ -716,8 +714,7 @@ public final class MediaChannel {
716714
/// MediaChannel の接続中に映像をソフトミュート有効化 / 無効化します
717715
///
718716
/// - Parameter mute: `true` で有効化、`false` で無効化
719-
/// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
720-
/// - Throws: エラー時は `SoraError.mediaChannelError` がスローされます
717+
/// - Returns: 成功した場合は `nil`、失敗した場合は `SoraError.mediaChannelError` を返します
721718
public func setVideoSoftMute(_ mute: Bool) -> Error? {
722719
// 接続中か
723720
guard state == .connected else {

0 commit comments

Comments
 (0)