CloudHub Docs
Download Documents

RTS


CloudHubRTS CPP

Enums

RTS_VIDEO_STATE

State of the video

EnumValueDescription
RTS_VIDEO_STATE_STOPPED0Stopped
RTS_VIDEO_STATE_STARTING1Starting

RTS_AUDIO_STATE

State of the audio

EnumValueDescription
RTS_AUDIO_STATE_STOPPED0Stopped
RTS_AUDIO_STATE_STARTING1Starting

FRAME_RATE

Video frame rates.

EnumValueDescription
FRAME_RATE_FPS_111 FPS
FRAME_RATE_FPS_777 FPS
FRAME_RATE_FPS_101010 FPS
FRAME_RATE_FPS_151515 FPS
FRAME_RATE_FPS_242424 FPS
FRAME_RATE_FPS_303030 FPS

DESKTOP_SOURCETYPE

Type of desktop

EnumValueDescription
SOURCE_SCREEN0Screen
SOURCE_WINDOW1Window

VIDEO_STICKER_TYPE

Sticker Name

EnumValueDescription
NONE0None
PRINCESS_MASK1Princess mask
EYEGLASSES_CAT2Black cat glasses
CARTOON_BOY3Cartoon boy
CARTOON_GIRL4Cartoon girl
NAUGHTY_BABY5Naughty baby
CHRISTMAS_ELK6Christmas elk
BIRTHDAY7Birthday
ICE_CREAM8Ice cream
LUCKY_CAT9Lucky cat
PIGGY10Piggy

AUDIO_QUALITY

Audio quality

EnumValueDescription
AUDIO_QUALITY_LOW0A sample rate of 16 KHz, audio encoding, mono, and a bitrate of up to 22 Kbps
AUDIO_QUALITY_DEFAULT1A sample rate of 32 KHz, audio encoding, mono, and a bitrate of up to 48 Kbps(default)
AUDIO_QUALITY_HIGH2A sample rate of 48 KHz, audio encoding, mono, and a bitrate of up to 64 Kbps
AUDIO_QUALITY_HIGH_STEREO3A sample rate of 48 KHz, audio encoding, stereo, and a bitrate of up to 96 Kbps
AUDIO_QUALITY_VERY_HIGH4A sample rate of 48 KHz, audio encoding, mono, and a bitrate of up to 96 Kbps
AUDIO_QUALITY_VERY_HIGH_STEREO5A sample rate of 48 KHz, audio encoding, stereo, and a bitrate of up to 128 Kbps

LOCAL_VIDEO_STREAM_STATE

Local video state types

EnumValueDescription
LOCAL_VIDEO_STREAM_STATE_STOPPED0Initial state
LOCAL_VIDEO_STREAM_STATE_CAPTURING1The local stream capturing device starts successfully
LOCAL_VIDEO_STREAM_STATE_ENCODING2The first stream frame is successfully encoded
LOCAL_VIDEO_STREAM_STATE_FAILED3The local stream fails to start

LOCAL_VIDEO_STREAM_ERROR

Local video state error codes.

EnumValueDescription
LOCAL_VIDEO_STREAM_ERROR_OK0The local video is normal
LOCAL_VIDEO_STREAM_ERROR_FAILURE1No specified reason for the local video failure
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION2No permission to use the local video capturing device
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY3The local video capturing device is in use
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE4The local video capture fails. Check whether the capturing device is working properly
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE5The local video encoding fails

LOCAL_AUDIO_STREAM_STATE

Local audio state types.

EnumValueDescription
LOCAL_AUDIO_STREAM_STATE_STOPPED0The local audio is in the initial state
LOCAL_AUDIO_STREAM_STATE_RECORDING1The capturing device starts successfully
LOCAL_AUDIO_STREAM_STATE_ENCODING2The first audio frame encodes successfully
LOCAL_AUDIO_STREAM_STATE_FAILED3The local audio fails to start

LOCAL_AUDIO_STREAM_ERROR

Local audio state error codes.

EnumValueDescription
LOCAL_AUDIO_STREAM_ERROR_OK0The local audio is normal
LOCAL_AUDIO_STREAM_ERROR_FAILURE1No specified reason for the local audio failure
LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION2No permission to use the local audio device
LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY3The microphone is in use
LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE4The local audio capturing fails. Check whether the capturing device is working properly
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE5The local audio encoding fails
LOCAL_AUDIO_STREAM_ERROR_MUTED6The local audio muted
LOCAL_AUDIO_STREAM_ERROR_UNMUTED7The local audio unmuted

MEDIA_DEVICE_STATE_TYPE

Media device states.

EnumValueDescription
MEDIA_DEVICE_STATE_ACTIVE1The device is in use
MEDIA_DEVICE_STATE_DISABLED2The device is disabled
MEDIA_DEVICE_STATE_NOT_PRESENT4The device is not present
MEDIA_DEVICE_STATE_UNPLUGGED8The device is unplugged

MEDIA_DEVICE_TYPE

Media device types.

EnumValueDescription
UNKNOWN_AUDIO_DEVICE-1Unknown device type
AUDIO_PLAYOUT_DEVICE0Audio playback device
AUDIO_RECORDING_DEVICE1Audio capturing device
VIDEO_RENDER_DEVICE2Video renderer
VIDEO_CAPTURE_DEVICE3Video capturer
AUDIO_APPLICATION_PLAYOUT_DEVICE4Application audio playback device