api/bytertc_defines library
Classes
- AudioPropertiesConfig
- Configuration related to audio property information prompt
- AudioPropertiesInfo
- Audio properties
- AudioRecordingConfig
- Audio recording configuration.
- CloudProxyInfo
- Cloud proxy information
- EchoTestConfig
- Video/audio call test configurations
- ForwardStreamEventInfo
- Information on events occurring in different target room during media stream relaying.
- ForwardStreamInfo
- Information about the target room for media stream relaying across rooms.
- ForwardStreamStateInfo
- Status and error messages for different target rooms during cross-room relaying of media streams
- HumanOrientation
- Three-dimensional orientation information, each pair of vectors need to be perpendicular.
- LocalAudioPropertiesInfo
- Local audio properties
- LocalAudioStats
- Local audio stream statistics called back every 2 seconds.
- LocalProxyConfiguration
- Detailed information of local proxy configurations.
- LocalSnapshot
- Result of the local snapshot.
- LocalStreamStats
- Local audio/video stream statistics and network status called back every 2s.
- LocalVideoStats
- Local video stream statistics called back every 2 seconds.
- MediaTypeEnhancementConfig
- Media type for cellular assisted Enhancement.
- NetworkQualityStats
- Tx/Rx network quality related data
- NetworkTimeInfo
- Network time info
- Position
- Coordinate value of the local user's position in the rectangular coordinate system in the RTC room.
- PositionInfo
- Information on the user's position in the rectangular coordinate system for the spatial audio.
- ProblemFeedbackInfo
- Feedback information on video call quality
- ProblemFeedbackRoomInfo
- Room info of the video call quality feedback.
- PublicStreaming
- Public stream configuration.
- PublicStreamingAudioConfig
- Audio parameters for public streams.
- PublicStreamingLayout
- Public stream layout information.
- PublicStreamingRegion
- Layout of each stream to be mixed into the public stream.
- PublicStreamingVideoConfig
- Video parameters for public streams.
- RecordingConfig
- Local recording configuration
- RecordingInfo
- Details of local recording
- RecordingProgress
- Local recording progress
- RemoteAudioPropertiesInfo
- Remote audio properties
- RemoteAudioStats
- Remote audio stream statistics called back every 2 seconds.
- RemoteSnapshot
- Result of the remote snapshot.
- RemoteStreamKey
- Information about the remote stream
- RemoteStreamStats
- Statistical information and network status of subscribed remote audio/video stream called back every 2s.
- RemoteStreamSwitch
- Stream switching information when a local user-subscribed remote stream triggers a fallback policy.
- RemoteVideoConfig
- Information on remote video frame.
- RemoteVideoStats
- Remote video stream statistics called back every 2 seconds.
- RoomConfig
- Room configuration.
- RTCLogConfig
- Local log parameters.
- RTCOrientation
- Direction orientation information
- RTCRoomStats
- Call-related statistics
- ScreenVideoEncoderConfig
- The encoding configuration for shared-screen streams. See Setting Video Encoder Configuration.
- SourceCrop
- Crop configuration of the public stream.
- SourceWantedData
- Performance fallback related data.
- StreamSyncInfoConfig
- Configuration related to media streaming information synchronization
- SubscribeConfig
- Subscription related configuration.
- SubtitleConfig
- Subtitle configurations.
- SubtitleMessage
- Related information about subtitles.
- SysStats
- Information on CPU and memory used by App.
- UserInfo
- User information
- VideoCaptureConfig
- Video capture configuration.
- VideoEncoderConfig
- Description of video stream parameters.
- VideoFrameInfo
- Video frame information。
- VirtualBackgroundSource
- Virtual background source.
- VoiceEqualizationConfig
- Voice equalization effect.
- VoiceReverbConfig
- Voice reverb effect.
- Watermark
- Watermark's scaled coordinates and size, relative to the video stream.
- WatermarkConfig
- Watermark configurations.
Enums
- AnsMode
- ANC modes. The ANC algorithm is determined by the room profile you set when calling RTCRoom.joinRoom.
- AttenuationType
- Mode of volume attenuation with distance from the sound source in spatial audio
- AudioAlignmentMode
- The alignment mode of remote audio streams.
- AudioChannel
- Audio channel
- AudioDeviceType
- Type of audio device
- AudioFrameSource
- Audio file recording source type.
- AudioMixingDualMonoMode
- Audio mixing playback channel type
- AudioMixingError
- Audio mixing related error code
- AudioMixingState
- Mixing audio playback status
- AudioMixingType
- Audio mixing type
- AudioProfileType
- Sound quality
- AudioPropertiesMode
- The audio info included in RTCVideoEventHandler.onLocalAudioPropertiesReport
- AudioQuality
- Audio quality.
- AudioRecordingErrorCode
- Error code for audio recording.
- AudioRecordingState
- Audio recording config
- AudioReportMode
- The volume callback modes.
- AudioRoute
- Audio playback device
- AudioSampleRate
- Audio sample rate in Hz.
- AudioScenario
- Audio scene type
- AudioSelectionPriority
- User priority configuration in the audio selection.
- AVSyncState
- A/V synchronization states
- BluetoothMode
- The Bluetooth profiles.
- CameraId
- Camera on a mobile device.
- DataMessageSourceType
- SEI data source type.
- EarMonitorMode
- Enable/disable in-ear monitoring.
- EchoTestResult
- Video/audio call test result
- EffectBeautyMode
- Basic beauty effect.
- EncryptType
- Custom encryption type
- ErrorCode
- The error code indicates that the SDK has encountered a non-recoverable error. It will be send to users through RTCVideoEventHandler.onError.
- FallbackOrRecoverReason
- Causes of fallback or recovery from fallback in remote subscription streams.
- FirstFramePlayState
- First frame playback status
- FirstFrameSendState
- First frame sending status
- ForwardStreamError
- Error code during cross-room relaying of media streams
- ForwardStreamEvent
- Events occurring in this target room during media stream relaying.
- ForwardStreamState
- Media stream relaying status
- HardwareEchoDetectionResult
- Result of the detection inited before joining a room.
- LocalAudioStreamError
- Error code returned when local audio stream state changes.
- LocalAudioStreamState
- Local audio stream status.
- LocalLogLevel
- Local log parameters.
- LocalProxyError
- The errors of local proxy connection.
- LocalProxyState
- The states of local proxy connection.
- LocalProxyType
- Types of local proxies.
- LocalVideoStreamError
- Error code returned when the local video state changes.
- LocalVideoStreamState
- Local video stream status and corresponding error code in LocalVideoStreamError.
- LoginErrorCode
- Login result
- LogoutReason
- The reason why the user log out.
- MediaDeviceError
- Media device error
- MediaDeviceState
- Media device state
- MediaDeviceWarning
- Media device warning
- MediaStreamType
- Media stream type.
- MessageConfig
- Reliability and orderliness of the message
- MirrorType
- Mirror type.
- NetworkDetectionLinkType
- Type of network detected before a call.
- NetworkDetectionStopReason
- Reasons for stopping network detection before a call
- NetworkQuality
- Media streaming network quality
- NetworkType
- Network connection type.
- PauseResumeControlMediaType
- Type of media stream supposed to be paused/resume.
- PerformanceAlarmMode
- Whether to enable publisher performance fallback
- PerformanceAlarmReason
- Reasons for performance-related alarms
- PlayerError
- Error code for audio player .
- PlayerState
- Player state.
- ProblemFeedbackOption
- Audio/video quality feedback
- PublicStreamErrorCode
- Error code for public stream
- PublishFallbackOption
- Stream fallback options of publisher
- RecordingErrorCode
- Local recording error code
- RecordingFileType
- Storage format of locally recorded files
- RecordingState
- Status of local recording
- RecordingType
- Locally recorded media type.
- RemoteAudioState
- Status of the subscribed remote audio stream and corresponding reason code in RemoteAudioStateChangeReason.
- RemoteAudioStateChangeReason
- Reasons for change in remote audio stream status
- RemoteUserPriority
-
Priority of the publisher. When a user encounters performance insufficiency of either the network or the device, the media stream will fall back in the ascending order of
RemoteUserPriority. - RemoteVideoState
- Remote video stream status and corresponding reason code in RemoteVideoStateChangeReason.
- RemoteVideoStateChangeReason
- Cause of remote video stream state change.
- ReturnStatus
- API call result.
- RoomMessageSendResult
- Result of broadcasting messages in the room
- RoomProfile
- Room mode
- RTCConnectionState
- Status of the SDK connection to the signalling server
- ScaleMode
- Video frame scale mode.
- ScreenMediaType
- Screen media type.
- ScreenVideoEncoderPreference
- The encoding modes for shared-screen streams.
- SEICountPerFrame
- SEI sending mode.
- SEIStreamUpdateEvent
- State of the black frame video stream
- SetRoomExtraInfoResult
- Extra information setting result.
- StreamIndex
- Stream type
- StreamRemoveReason
- The reason for the removal of the remote stream in the room.
- SubscribeFallbackOption
- Stream fallback options of subscriber
- SubscribeState
- Subscription status
- SubtitleErrorCode
- Error codes of the subtitling task.
- SubtitleMode
- Subtitle modes.
- SubtitleState
- The states of the subtitling task.
- SyncInfoStreamType
- Stream type for synchronization
- TorchState
- Camera flash status.
- TranscoderContentControlType
- Stream mixing content type.
- UserMessageSendResult
- Message delivery result
- UserOfflineReason
- The reason why the remote user leaves the room.
- UserOnlineStatus
- User online status
- UserVisibilityChangeError
- User visibility state change error.
- VideoCapturePreference
- Video capture preference.
- VideoCodecType
- Video encoding type
- VideoDeviceType
- Current audio device type.
- VideoEncoderPreference
- Coding strategy preference.
- VideoOrientation
- Orientation of the video frame.
- VideoRenderMode
- Video rendering scale mode.
- VideoRotation
- Video frame rotation angle.
- VideoRotationMode
- Video orientation.
- VirtualBackgroundSourceType
- Virtual background types.
- VoiceChangerType
- Types of voice change effects.
- VoiceEqualizationBandFrequency
- Audio Equalization effect.
- VoiceReverbType
- Types of reverb effects
- WarningCode
- The warning code indicates that the SDK has encountered a problem and is trying to recover. It only serves as a notification.
- ZoomConfigType
- Digital Zoom type。
- ZoomDirectionType
- Action of the digital zoom control.