AGAudioRawDataDispatcher | Edu Store Typescript API Reference for Web

Hierarchy

AGAudioRawDataDispatcher

Index

Constructors

constructor

Properties

logger

Accessors

Methods

Constructors

constructor

new AGAudioRawDataDispatcher(): AGAudioRawDataDispatcher

Returns AGAudioRawDataDispatcher

Properties

logger

logger: "agora-rte-sdk/src/core/logger/type".Logger

Accessors

audioTrackRawDataConfig

get audioTrackRawDataConfig(): AgoraRteAudioRawDataConfig

Returns AgoraRteAudioRawDataConfig

hasAudioTrackRawDataObservers

get hasAudioTrackRawDataObservers(): boolean

Returns boolean

hasMicrophoneRawDataObservers

get hasMicrophoneRawDataObservers(): boolean

Returns boolean

isStarted

get isStarted(): boolean

Returns boolean

microphoneTrackRawDataConfig

get microphoneTrackRawDataConfig(): AgoraRteAudioRawDataConfig

Returns AgoraRteAudioRawDataConfig

Methods

addAudioRawDataObserver

addAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): void

Parameters
- observer: AgoraRteAudioRawDataObserver
- position: AgoraRteAudioRawDataPosition
Returns void

dispatch

dispatch(event: "AudioRawDataRecored", ...params: [rawData: AgoraRteAudioRawData]): void
dispatch(event: "AudioRawDataBeforeMixed", ...params: [rawData: AgoraRteAudioRawData, streamUuid: string, channelName: string]): void
dispatch(event: "ObserverChanged", ...params: [position: AgoraRteAudioRawDataPosition]): void
dispatch(event: "MicrophoneTrackCreated", ...params: [track: ILocalAudioTrack]): void
dispatch(event: "AudioTrackSubscribed", ...params: [track: IRemoteAudioTrack, streamUuid: string, channelName: string]): void
dispatch(event: "MicrophoneTrackDestroyed", ...params: []): void
dispatch(event: "AudioTrackUnsubscribed", ...params: [streamUuid: string, channelName: string]): void
dispatch(event: "Start", ...params: []): void
dispatch(event: "Stop", ...params: []): void

Parameters
- event: "AudioRawDataRecored"
- Rest ...params: [rawData: AgoraRteAudioRawData]
Returns void
Parameters
- event: "AudioRawDataBeforeMixed"
- Rest ...params: [rawData: AgoraRteAudioRawData, streamUuid: string, channelName: string]
Returns void
Parameters
- event: "ObserverChanged"
- Rest ...params: [position: AgoraRteAudioRawDataPosition]
Returns void
Parameters
- event: "MicrophoneTrackCreated"
- Rest ...params: [track: ILocalAudioTrack]
Returns void
Parameters
- event: "AudioTrackSubscribed"
- Rest ...params: [track: IRemoteAudioTrack, streamUuid: string, channelName: string]
Returns void
Parameters
- event: "MicrophoneTrackDestroyed"
- Rest ...params: []
Returns void
Parameters
- event: "AudioTrackUnsubscribed"
- Rest ...params: [streamUuid: string, channelName: string]
Returns void
Parameters
- event: "Start"
- Rest ...params: []
Returns void
Parameters
- event: "Stop"
- Rest ...params: []
Returns void

register

Parameters
- event: "AudioRawDataRecored"
- callback: CallbackRawDataRecorded
Returns void
Parameters
- event: "AudioRawDataBeforeMixed"
- callback: CallbackRawDataBeforeMixed
Returns void
Parameters
- event: "ObserverChanged"
- callback: CallbackObserverChanged
Returns void
Parameters
- event: "MicrophoneTrackCreated"
- callback: CallbackMicrophoneTrackCreated
Returns void
Parameters
- event: "AudioTrackSubscribed"
- callback: CallbackAudioTrackSubscribed
Returns void
Parameters
- event: "MicrophoneTrackDestroyed"
- callback: CallbackMicrophoneTrackDestroyed
Returns void
Parameters
- event: "AudioTrackUnsubscribed"
- callback: CallbackAudioTrackUnsubscribed
Returns void
Parameters
- event: "Start"
- callback: CallbackStart
Returns void
Parameters
- event: "Stop"
- callback: CallbackStop
Returns void

removeAudioRawDataObserver

removeAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): void

Parameters
- observer: AgoraRteAudioRawDataObserver
- position: AgoraRteAudioRawDataPosition
Returns void

setConfig

setConfig(config: AgoraRteAudioRawDataConfig, position: AgoraRteAudioRawDataPosition): void

Parameters
- config: AgoraRteAudioRawDataConfig
- position: AgoraRteAudioRawDataPosition
Returns void

start

start(): void

Returns void

stop

stop(): void

Returns void

unregister

unregister(event: "AudioRawDataRecored", callback: CallbackRawDataRecorded): void
unregister(event: "AudioRawDataBeforeMixed", callback: CallbackRawDataBeforeMixed): void
unregister(event: "ObserverChanged", callback: CallbackObserverChanged): void
unregister(event: "MicrophoneTrackCreated", callback: CallbackMicrophoneTrackCreated): void
unregister(event: "AudioTrackSubscribed", callback: CallbackAudioTrackSubscribed): void
unregister(event: "MicrophoneTrackDestroyed", callback: CallbackMicrophoneTrackDestroyed): void
unregister(event: "AudioTrackUnsubscribed", callback: CallbackAudioTrackUnsubscribed): void
unregister(event: "Start", callback: CallbackStart): void
unregister(event: "Stop", callback: CallbackStop): void

Parameters
- event: "AudioRawDataRecored"
- callback: CallbackRawDataRecorded
Returns void
Parameters
- event: "AudioRawDataBeforeMixed"
- callback: CallbackRawDataBeforeMixed
Returns void
Parameters
- event: "ObserverChanged"
- callback: CallbackObserverChanged
Returns void
Parameters
- event: "MicrophoneTrackCreated"
- callback: CallbackMicrophoneTrackCreated
Returns void
Parameters
- event: "AudioTrackSubscribed"
- callback: CallbackAudioTrackSubscribed
Returns void
Parameters
- event: "MicrophoneTrackDestroyed"
- callback: CallbackMicrophoneTrackDestroyed
Returns void
Parameters
- event: "AudioTrackUnsubscribed"
- callback: CallbackAudioTrackUnsubscribed
Returns void
Parameters
- event: "Start"
- callback: CallbackStart
Returns void
Parameters
- event: "Stop"
- callback: CallbackStop
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AGAudioRawDataDispatcher

Properties

logger

Accessors

audioTrackRawDataConfig

Returns AgoraRteAudioRawDataConfig

hasAudioTrackRawDataObservers

Returns boolean

hasMicrophoneRawDataObservers

Returns boolean

isStarted

Returns boolean

microphoneTrackRawDataConfig

Returns AgoraRteAudioRawDataConfig

Methods

addAudioRawDataObserver

Parameters

observer: AgoraRteAudioRawDataObserver

position: AgoraRteAudioRawDataPosition

Returns void

dispatch

Parameters

event: "AudioRawDataRecored"

Rest ...params: [rawData: AgoraRteAudioRawData]

Returns void

Parameters

event: "AudioRawDataBeforeMixed"

Rest ...params: [rawData: AgoraRteAudioRawData, streamUuid: string, channelName: string]

Returns void

Parameters

event: "ObserverChanged"

Rest ...params: [position: AgoraRteAudioRawDataPosition]

Returns void

Parameters

event: "MicrophoneTrackCreated"

Rest ...params: [track: ILocalAudioTrack]

Returns void

Parameters

event: "AudioTrackSubscribed"

Rest ...params: [track: IRemoteAudioTrack, streamUuid: string, channelName: string]

Returns void

Parameters

event: "MicrophoneTrackDestroyed"

Rest ...params: []

Returns void

Parameters

event: "AudioTrackUnsubscribed"

Rest ...params: [streamUuid: string, channelName: string]

Returns void

Parameters

event: "Start"

Rest ...params: []

Returns void

Parameters

event: "Stop"

Rest ...params: []

Returns void

register

Parameters

event: "AudioRawDataRecored"

callback: CallbackRawDataRecorded

Returns void

Parameters

event: "AudioRawDataBeforeMixed"

callback: CallbackRawDataBeforeMixed

Returns void

Parameters

event: "ObserverChanged"

callback: CallbackObserverChanged

Returns void

Parameters

event: "MicrophoneTrackCreated"