Whether a media track is playing on the webpage:
true
: The media track is playing on the webpage.false
: The media track is not playing on the webpage.The type of a media track:
"audio"
: Audio track."video"
: Video track.Listens for a specified event.
When the specified event happens, the SDK triggers the callback that you pass.
The event name.
The callback to trigger.
Occurs when the first remote audio or video frame is decoded.
IRemoteTrack
Events
Sets the callback for getting raw audio data in PCM format.
After you successfully set the callback, the SDK constantly returns the audio frames of a remote audio track in this callback by using AudioBuffer.
You can set the
frameSize
parameter to determine the frame size in each callback, which affects the interval between the callbacks. The larger the frame size, the longer the interval between them.
track.setAudioFrameCallback((buffer) => {
for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
// Float32Array with PCM data
const currentChannelData = buffer.getChannelData(channel);
console.log("PCM data in channel", channel, currentChannelData);
}
}, 2048);
// ....
// Stop getting the raw audio data
track.setAudioFrameCallback(null);
The callback function for receiving the AudioBuffer object. If you set audioBufferCallback
as null
, the SDK stops getting raw audio data.
Optional
frameSize: numberThe number of samples of each audio channel that an AudioBuffer
object contains. You can set frameSize
as 256, 512, 1024, 2048, 4096, 8192, or 16384. The default value is 4096.
Since
4.1.0
Sets the audio playback device, for example, the speaker.
This method supports Chrome only. Other browsers throw a '
NOT_SUPPORTED
error when calling this method.
Device ID, which can be retrieved by calling getPlaybackDevices.
Generated using TypeDoc
RemoteAudioTrack
is the basic interface for the remote audio track.You can get create a remote audio track by the [AgoraRTCRemoteUser.audioTrack]audioTrack object after calling [subscribe]subscribe.