AVAudioSession.SetActive 方法

定義

命名空間:

AVFoundation

組件:

Xamarin.iOS.dll

多載

SetActive(Boolean)	啟用或停用應用程式的音訊會話。
SetActive(Boolean, AVAudioSessionSetActiveOptions)	啟用和停用應用程式的音訊會話。
SetActive(Boolean, NSError)	啟用或停用應用程式的音訊會話。
SetActive(Boolean, AVAudioSessionFlags, NSError)	應用程式開發人員不應該使用此已被取代的方法。
SetActive(Boolean, AVAudioSessionSetActiveOptions, NSError)	啟用和停用應用程式的音訊會話。

SetActive(Boolean)

啟用或停用應用程式的音訊會話。

public Foundation.NSError SetActive (bool beActive);

member this.SetActive : bool -> Foundation.NSError

參數

beActive

Boolean

設定為 true 以啟用音訊，false 表示停用。

傳回

NSError

在成功時為 null，或在失敗時為 NSError 的實例。

備註

如果音訊優先順序高於您目前執行的應用程式，音訊啟用可能會失敗。

如果進行中的音訊作業 (播放、錄製、音訊佇列或轉換) ，音訊停用可能會失敗。

SetActive(Boolean, AVAudioSessionSetActiveOptions)

啟用和停用應用程式的音訊會話。

public Foundation.NSError SetActive (bool active, AVFoundation.AVAudioSessionSetActiveOptions options);

member this.SetActive : bool * AVFoundation.AVAudioSessionSetActiveOptions -> Foundation.NSError

參數

active

Boolean

設定為 true 以啟用音訊，false 表示停用。

options

AVAudioSessionSetActiveOptions

控制音訊啟用的選項。

傳回

NSError

在成功時為 null，或在失敗時為 NSError 的實例。

備註

如果音訊優先順序高於您目前執行的應用程式，音訊啟用可能會失敗。

如果進行中的音訊作業 (播放、錄製、音訊佇列或轉換) ，音訊停用可能會失敗。

SetActive(Boolean, NSError)

啟用或停用應用程式的音訊會話。

[Foundation.Export("setActive:error:")]
public virtual bool SetActive (bool beActive, out Foundation.NSError outError);

abstract member SetActive : bool *  -> bool
override this.SetActive : bool *  -> bool

參數

beActive

Boolean

設定為 true 以啟用音訊，false 表示停用。

outError

NSError

失敗時，這包含錯誤詳細資料。

傳回

Boolean

true 表示成功，錯誤為 false。 如果發生錯誤，outError 參數會包含描述問題的 NSError 新實例。

屬性

ExportAttribute

備註

如果音訊優先順序高於您目前執行的應用程式，音訊啟用可能會失敗。

如果進行中的音訊作業 (播放、錄製、音訊佇列或轉換) ，音訊停用可能會失敗。

SetActive(Boolean, AVAudioSessionFlags, NSError)

應用程式開發人員不應該使用此已被取代的方法。

[Foundation.Export("setActive:withFlags:error:")]
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 6, 0, ObjCRuntime.PlatformArchitecture.All, "Use 'SetActive (bool, AVAudioSessionSetActiveOptions, out NSError)' instead.")]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
public virtual bool SetActive (bool beActive, AVFoundation.AVAudioSessionFlags flags, out Foundation.NSError outError);

abstract member SetActive : bool * AVFoundation.AVAudioSessionFlags *  -> bool
override this.SetActive : bool * AVFoundation.AVAudioSessionFlags *  -> bool

參數

beActive

Boolean

flags

AVAudioSessionFlags

outError

NSError

失敗時，這包含錯誤詳細資料。

傳回

Boolean

true 如果要求成功，則 outError 參數會包含描述問題的 NSError 實例。

屬性

ExportAttribute DeprecatedAttribute UnavailableAttribute

SetActive(Boolean, AVAudioSessionSetActiveOptions, NSError)

啟用和停用應用程式的音訊會話。

[Foundation.Export("setActive:withOptions:error:")]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 6, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public virtual bool SetActive (bool active, AVFoundation.AVAudioSessionSetActiveOptions options, out Foundation.NSError outError);

abstract member SetActive : bool * AVFoundation.AVAudioSessionSetActiveOptions *  -> bool
override this.SetActive : bool * AVFoundation.AVAudioSessionSetActiveOptions *  -> bool

參數

active

Boolean

設定為 true 以啟用音訊，false 表示停用。

options

AVAudioSessionSetActiveOptions

控制音訊啟用的選項。

outError

NSError

失敗時，這包含錯誤詳細資料。

傳回

Boolean

true 如果要求成功，則 outError 參數會包含描述問題的 NSError 實例。

屬性

ExportAttribute IntroducedAttribute

備註

如果音訊優先順序高於您目前執行的應用程式，音訊啟用可能會失敗。

如果進行中的音訊作業 (播放、錄製、音訊佇列或轉換) ，音訊停用可能會失敗。