LocalAudioStream class

Пакет:

@azure/communication-calling

Представляет локальный аудиопоток для локального устройства michrophone

Конструкторы

LocalAudioStream(AudioDeviceInfo)	Create локального аудиопотока
LocalAudioStream(MediaStream)

Свойства

mediaStreamType	Получение типа потока мультимедиа для этого LocalAudioStream
source	Получение текущего источника звука для этого LocalAudioStream

Методы

dispose()	Требуется вызвать dispose, если объект LocalAudioStream не указан в CallOptions
feature<TFeature>(AudioStreamFeatureFactory<TFeature>)	Извлекает инициализированный и замеченный объект Feature с расширенным API. Проверьте объект Features.* для всех доступных расширенных функций в этом пакете. В настоящее время поддерживается — Features.AudioEffects
getMediaStream()	Получение потока мультимедиа.
getVolume()	Необходимо вызвать getVolume в audioSourceChanged, чтобы получить новый объект тома, привязанный к новому источнику
off("audioSourceChanged", AudioSourceChangedEvent)	Отмена подписки на событие audioSourceChanged.
on("audioSourceChanged", AudioSourceChangedEvent)	Функция subscribe для события audioSourceChanged.
setMediaStream(MediaStream)	Переключение на использование другого аудиопотока
switchSource(AudioDeviceInfo)	Переключение на использование другого источника звука

Сведения о конструкторе

LocalAudioStream(AudioDeviceInfo)

Create локального аудиопотока

new LocalAudioStream(source: AudioDeviceInfo)

Параметры

source

AudioDeviceInfo

Используемый источник микрофона или медиапотока.

LocalAudioStream(MediaStream)

new LocalAudioStream(source: MediaStream)

Параметры

source

MediaStream

Сведения о свойстве

mediaStreamType

Получение типа потока мультимедиа для этого LocalAudioStream

MediaStreamType mediaStreamType

Значение свойства

MediaStreamType

source

Получение текущего источника звука для этого LocalAudioStream

AudioDeviceInfo source

Значение свойства

AudioDeviceInfo

Сведения о методе

dispose()

Требуется вызвать dispose, если объект LocalAudioStream не указан в CallOptions

function dispose()

feature<TFeature>(AudioStreamFeatureFactory<TFeature>)

Примечание

API пребывает в бета-версии и предоставляется в качестве предварительной версии для разработчиков. На основе полученных отзывов мы можем внести изменения. Не используйте этот API в рабочей среде.

Извлекает инициализированный и замеченный объект Feature с расширенным API. Проверьте объект Features.* для всех доступных расширенных функций в этом пакете. В настоящее время поддерживается — Features.AudioEffects

function feature<TFeature>(factory: AudioStreamFeatureFactory<TFeature>): TFeature

Параметры

factory

AudioStreamFeatureFactory<TFeature>

Фабрика для конструктора функций аудиопотока, который предоставляет расширенный API

Возвращаемое значение

TFeature

getMediaStream()

Получение потока мультимедиа.

function getMediaStream(): Promise<MediaStream>

Возвращаемое значение

Promise<MediaStream>

getVolume()

Необходимо вызвать getVolume в audioSourceChanged, чтобы получить новый объект тома, привязанный к новому источнику

function getVolume(): Promise<Volume>

Возвращаемое значение

Promise<Volume>

off("audioSourceChanged", AudioSourceChangedEvent)

Отмена подписки на событие audioSourceChanged.

function off(event: "audioSourceChanged", listener: AudioSourceChangedEvent)

Параметры

event

"audioSourceChanged"

имя события.

listener

AudioSourceChangedEvent

обратный вызов fn, который использовался для подписки на это событие.

on("audioSourceChanged", AudioSourceChangedEvent)

Функция subscribe для события audioSourceChanged.

function on(event: "audioSourceChanged", listener: AudioSourceChangedEvent)

Параметры

event

"audioSourceChanged"

имя события.

listener

AudioSourceChangedEvent

обратный вызов fn, который будет вызываться при изменении источника звука.

setMediaStream(MediaStream)

Переключение на использование другого аудиопотока

function setMediaStream(source: MediaStream): Promise<void>

Параметры

source

MediaStream

Новый аудиопоток для использования.

Возвращаемое значение

Promise<void>

switchSource(AudioDeviceInfo)

Переключение на использование другого источника звука

function switchSource(source: AudioDeviceInfo): Promise<void>

Параметры

source

AudioDeviceInfo

Новый источник аудио для использования.

Возвращаемое значение

Promise<void>