Interface RemoteAudioTrackProps

interface RemoteAudioTrackProps {
    children?: ReactNode;
    play?: boolean;
    playbackDeviceId?: string;
    track?: Nullable<IRemoteAudioTrack>;
    volume?: number;
}

Properties

children? play? playbackDeviceId? track? volume?

Properties

Optional Readonly children

children?: ReactNode

The React nodes to be rendered.

Optional Readonly play

play?: boolean

true: Play the track.false: Stop playing the track.

Optional Readonly playbackDeviceId

playbackDeviceId?: string

The ID of the playback device, such as a speaker. The device ID can be obtained using IAgoraRTC.getPlaybackDevices. This property is only supported in the desktop version of Chrome browser. Modifying the value of this property in other browsers throws a NOT_SUPPORTED error.

Optional Readonly track

track?: Nullable<IRemoteAudioTrack>

The remote audio track to be played.

Optional Readonly volume

volume?: number

The volume. The value ranges from 0 (mute) to 100 (the original volume).

Settings

Member Visibility

Theme

On This Page

childrenplayplaybackDeviceIdtrackvolume