Enumeration ChannelMediaRelayStateConst

The state code of the media stream relay. You can get the code through [AgoraRTCClient.on("channel-media-relay-state")]IAgoraRTCClient.event_channel_media_relay_state.

Enumeration Members

RELAY_STATE_CONNECTING RELAY_STATE_FAILURE RELAY_STATE_IDLE RELAY_STATE_RUNNING

Enumeration Members

RELAY_STATE_CONNECTING

RELAY_STATE_CONNECTING: "RELAY_STATE_CONNECTING"

The SDK is connecting to the media stream relay service.

RELAY_STATE_FAILURE

RELAY_STATE_FAILURE: "RELAY_STATE_FAILURE"

An error occurs in the media stream relay. See ChannelMediaRelayError for the error code.

RELAY_STATE_IDLE

RELAY_STATE_IDLE: "RELAY_STATE_IDLE"

The SDK is initialized, but has not started the media stream relay service.

RELAY_STATE_RUNNING

RELAY_STATE_RUNNING: "RELAY_STATE_RUNNING"

The SDK successfully relays the media stream to the destination channel.

Settings

Member Visibility

Theme

Generated using TypeDoc