继承自 agora_gaming_rtc.IAudioPlaybackDeviceManager .

Public 成员函数

override bool CreateAAudioPlaybackDeviceManager ()
 
override int ReleaseAAudioPlaybackDeviceManager ()
 
override int GetAudioPlaybackDeviceCount ()
 
override int GetAudioPlaybackDevice (int index, ref string deviceName, ref string deviceId)
 
override int GetCurrentPlaybackDevice (ref string deviceId)
 
override int SetAudioPlaybackDevice (string deviceId)
 
override int SetAudioPlaybackDeviceVolume (int volume)
 
override int GetAudioPlaybackDeviceVolume ()
 
override int SetAudioPlaybackDeviceMute (bool mute)
 
override bool IsAudioPlaybackDeviceMute ()
 
override int StartAudioPlaybackDeviceTest (string testAudioFilePath)
 
override int StopAudioPlaybackDeviceTest ()
 
override int GetCurrentPlaybackDeviceInfo (ref string deviceName, ref string deviceId)
 

详细描述

成员函数说明

◆ CreateAAudioPlaybackDeviceManager()

override bool agora_gaming_rtc.AudioPlaybackDeviceManager.CreateAAudioPlaybackDeviceManager ( )

创建 AudioPlaybackDeviceManager 实例。

注解
调用此方法后,请确保调用 ReleaseAAudioPlaybackDeviceManager 方法释放此实例。
返回
  • true: 方法调用成功;
  • false: 方法调用失败。

◆ ReleaseAAudioPlaybackDeviceManager()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.ReleaseAAudioPlaybackDeviceManager ( )

释放 AudioPlaybackDeviceManager 实例。

返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetAudioPlaybackDeviceCount()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.GetAudioPlaybackDeviceCount ( )

获取系统中被索引的音频播放设备的总数。

返回
被索引的音频播放设备的总数。

◆ GetAudioPlaybackDevice()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.GetAudioPlaybackDevice ( int  index,
ref string  deviceName,
ref string  deviceId 
)

获取某个被索引的音频播放设备的指定信息。

调用该方法后,SDK 会根据索引获取音频播放设备的设备名称和设备 ID。

注解
GetAudioPlaybackDeviceCount 方法后调用该方法。
参数
index指定的索引值,必须小于 GetAudioPlaybackDeviceCount 的返回值。
deviceName设备名称。
deviceId设备 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetCurrentPlaybackDevice()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.GetCurrentPlaybackDevice ( ref string  deviceId)

获取当前音频播放设备的 ID。

参数
deviceId当前音频播放设备的 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ SetAudioPlaybackDevice()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.SetAudioPlaybackDevice ( string  deviceId)

通过设备 ID 设置指定的音频播放设备。

注解
参数
deviceId设备 ID,可通过 GetAudioPlaybackDevice 获取。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ SetAudioPlaybackDeviceVolume()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.SetAudioPlaybackDeviceVolume ( int  volume)

设置音频播放设备音量。

参数
volume音频播放设备音量。取值可在 [0,255]。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetAudioPlaybackDeviceVolume()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.GetAudioPlaybackDeviceVolume ( )

获取当前音频播放设备的音量。

返回
  • ≥ 0: 方法调用成功则返回当前音频播放设备的音量。
  • < 0: 方法调用失败。

◆ SetAudioPlaybackDeviceMute()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.SetAudioPlaybackDeviceMute ( bool  mute)

静音播放设备。

参数
mute- true: 设备设为静音;
  • false: 设备设为不静音。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ IsAudioPlaybackDeviceMute()

override bool agora_gaming_rtc.AudioPlaybackDeviceManager.IsAudioPlaybackDeviceMute ( )

获取当前音频播放设备的静音状态。

返回
当前音频播放设备的静音状态。
  • true: 为静音状态;
  • false: 为非静音状态。

◆ StartAudioPlaybackDeviceTest()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.StartAudioPlaybackDeviceTest ( string  testAudioFilePath)

启动音频播放设备测试。

该方法测试音频播放设备是否能正常工作。SDK播放指定的音频文件,测试者如果能听到声音,说明音频播放设备能正常工作。

注解
调用该方法后,请确保调用 StopAudioPlaybackDeviceTest 停止测试。
参数
testAudioFilePath音频文件的绝对路径,路径字符串使用 UTF-8 编码格式。
  • 支持文件格式: wav、mp3、m4a、aac;
  • 支持文件采样率: 8000、16000、32000、44100、48000。
返回
  • 0: 方法调用成功,测试者可以听到声音。
  • < 0: 方法调用失败。

◆ StopAudioPlaybackDeviceTest()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.StopAudioPlaybackDeviceTest ( )

停止音频播放设备测试。

注解
请确保调用 StartAudioPlaybackDeviceTest 后调用该方法停止测试。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetCurrentPlaybackDeviceInfo()

override int agora_gaming_rtc.AudioPlaybackDeviceManager.GetCurrentPlaybackDeviceInfo ( ref string  deviceName,
ref string  deviceId 
)

获取当前音频播放设备的信息。

参数
deviceName当前播放设备的设备名称。
deviceId当前播放设备的设备 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。