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

注解

如果音频优先级高于你的应用程序当前正在运行，则音频激活可能会失败。

如果正在运行的音频操作 (播放、录制、音频队列或转换) ，则音频停用可能会失败。