Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration STREAM_SUBSCRIBE_STATE

The subscribing state.

since

v3.2.0

Index

Enumeration members

SUB_STATE_IDLE

SUB_STATE_IDLE: = 0

0: The initial subscribing state after joining the channel.

SUB_STATE_NO_SUBSCRIBED

SUB_STATE_NO_SUBSCRIBED: = 1

1: Fails to subscribe to the remote stream. Possible reasons:

  • The remote user:
    • Calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" or \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" to stop sending local streams.
    • Calls \ref IRtcEngine::disableAudio "disableAudio" or \ref IRtcEngine::disableVideo "disableVideo" to disable the entire audio or video modules.
    • Calls \ref IRtcEngine::enableLocalAudio "enableLocalAudio(false)" or \ref IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local audio sampling or video capturing.
    • The role of the remote user is AUDIENCE.
  • The local user calls the following methods to stop receiving remote streams:
    • Calls \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream(true)", \ref IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteAudioStreams "setDefaultMuteAllRemoteAudioStreams(true)" to stop receiving remote audio streams.
    • Calls \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream(true)", \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteVideoStreams "setDefaultMuteAllRemoteVideoStreams(true)" to stop receiving remote video streams.

SUB_STATE_SUBSCRIBED

SUB_STATE_SUBSCRIBED: = 3

3: Subscribes to and receives the remote stream successfully.

SUB_STATE_SUBSCRIBING

SUB_STATE_SUBSCRIBING: = 2

2: Subscribing.