byteplus_rtc library

Classes

AudioEffectPlayerConfig
Audio mixing configuration
AudioMixingConfig
Audio mixing configuration
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
FaceDetectionResult
Face detection result.
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.
LiveTranscoding
Configurations of pushing streams to CDN.
LiveTranscodingAudioConfig
Audio transcoding related configurations.
LiveTranscodingLayout
Layout information about pushing streams to CDN.
LiveTranscodingRegion
Information about layout of a single video stream in a mixed stream.
LiveTranscodingSpatialConfig
Spatial audio config when pushing to CDN.
LiveTranscodingVideoConfig
Video transcoding related configurations.
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.
MediaPlayerConfig
Audio mixing configuration
MediaTypeEnhancementConfig
Media type for cellular assisted Enhancement.
MixedStreamAudioConfig
Audio transcoding configurations.(New)
With invalid or empty input, the configurations will be set as the default values.
These parameters cannot be updated while pushing stream to the CDN.
MixedStreamConfig
Configurations to be set when pushing media streams to CDN.(New)
MixedStreamLayoutConfig
The overall video layout of the mixed stream.(New)
MixedStreamLayoutRegionConfig
Layout information for one of the video streams or image to be mixed.(New)
After starting to push streams to CDN and mixing multiple video streams, you can set the layout information for each of them.
MixedStreamLayoutRegionImageWaterMarkConfig
Image parameters for stream mixing.(New)
MixedStreamServerControlConfig
Configurations to be set while mixing streams on the server side.
MixedStreamSpatialConfig
Spatial audio config when pushing to CDN.(New)
MixedStreamVideoConfig
Video transcoding configurations.(New)
With invalid or empty input, the configurations will be set as the default values.
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.
PushSingleStreamParam
Configurations for pushing a single media stream to CDN.
ReceiveRange
The range in which local user can hear audio with attenuation effect.
RecordingConfig
Local recording configuration
RecordingInfo
Details of local recording
RecordingProgress
Local recording progress
Rectangle
Rectangle area.
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.
RTCAudioEffectPlayer
Audio effect player.
RTCAudioEffectPlayerEventHandler
Event handler for RTCAudioEffectPlayer. You must call RTCAudioEffectPlayer.setEventHandler to set the corresponding event handler to get the events.
RTCAudioMixingManager
Audio mixing management
RTCFaceDetectionObserver
Face detection observer
RTCLiveTranscodingObserver
Observer in pushing streams to CDN
RTCLogConfig
Local log parameters.
RTCMediaPlayer
Audio effect player.
RTCMediaPlayerEventHandler
Event handler for RTCMediaPlayer. You must call RTCMediaPlayer.setEventHandler to set the corresponding event handler to get the events.
RTCMixedStreamObserver
Register this observer to receive stream mixing related callbacks from the SDK.
RTCOrientation
Direction orientation information
RTCPushSingleStreamToCDNObserver
Observer in pushing single stream to CDN
RTCRangeAudio
Range audio instance
RTCRoom
Room instance
RTCRoomEventHandler
Room event callbacks.
RTCRoomStats
Call-related statistics
RTCSpatialAudio
Spatial audio instance
RTCSurfaceView
Video rendering settings
RTCVideo
The engine instance.
RTCVideoContext
Used to initialize the RTCVideo.
RTCVideoEffect
Advanced video effects.
RTCVideoEventHandler
RTCVideo event callback
RTCViewContext
Used for initialize RTCSurfaceView
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.
TranscoderLayoutRegionDataParam
Image parameters for stream mixing
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

AACProfile
Advanced Audio Coding (AAC) profile
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.
MixedStreamAudioCodecType
The audio codec.(New)
MixedStreamAudioProfile
Advanced Audio Coding (AAC) profile.(New)
MixedStreamErrorCode
Errors occurring during pushing streams to CDN. (New)
MixedStreamEvent
Events during pushing streams to CDN. (New)
MixedStreamLayoutRegionType
Stream mixing region type.(New)
MixedStreamMediaType
Stream mixing content type.(New)
MixedStreamRenderMode
The render mode.(New)
MixedStreamSEIContentMode
Content of SEI sent while pushing mixed stream to CDN.
MixedStreamType
Stream mixing type. (New)
MixedStreamVideoCodecType
The video codec.(New)
MixedStreamVideoType
Stream type in the region.
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
StreamMixingEvent
Events during pushing streams to CDN.
StreamMixingType
Stream mixing type.
StreamRemoveReason
The reason for the removal of the remote stream in the room.
StreamSinglePushEvent
Status when pushing a single media stream to CDN.
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.
TranscoderErrorCode
Errors occurring during pushing streams to CDN.
TranscoderLayoutRegionType
Stream mixing region type.
TranscodingAudioCodec
Audio codec type.
TranscodingVideoCodec
Video codec 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.
VideoCanvasType
Video canvas type
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.
ViewType
View type for video rendering in Android.
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.

Typedefs

OnActiveSpeakerType = void Function(String roomId, String uid)
roomId: ID of the room where the ActiveSpeaker stays
OnAudioDeviceStateChangedType = void Function(String deviceId, AudioDeviceType deviceType, MediaDeviceState deviceState, MediaDeviceError deviceError)
deviceId: Device ID
OnAudioDeviceWarningType = void Function(String deviceId, AudioDeviceType deviceType, MediaDeviceWarning deviceWarning)
deviceId: Device ID
OnAudioEffectPlayerStateChangedType = void Function(int effectId, PlayerState state, PlayerError error)
effectId: The ID of RTCAudioEffectPlayer. Set by RTCVideo.getAudioEffectPlayer.
OnAudioMixingPlayingProgressType = void Function(int mixId, int progress)
mixId: Audio mixing task ID.
OnAudioMixingStateChangedType = void Function(int mixId, AudioMixingState state, AudioMixingError error)
mixId: Audio mixing task ID.
OnAudioRecordingStateUpdateType = void Function(AudioRecordingState state, AudioRecordingErrorCode errorCode)
state: Recording state.
OnAudioRouteChangedType = void Function(AudioRoute route)
route: New audio playback routing
OnAudioStreamBannedType = void Function(String uid, bool banned)
uid: ID of the user of whom the published audio stream is banned/unbanned.
OnAVSyncStateChangeType = void Function(AVSyncState state)
state: A/V synchronization status.
OnCloudProxyConnectedType = void Function(int interval)
interval: Time elapsed from enabling the cloud proxy to successful connection, in ms.
OnConnectionStateChanged = void Function(RTCConnectionState state)
state: Current connection status between SDK and signaling server.
OnCreateRoomStateChangedType = void Function(String roomId, int errorCode)
roomId: The ID of the room where the error occurred.
OnEchoTestResultType = void Function(EchoTestResult result)
result: Detection result.
OnErrorType = void Function(ErrorCode code)
code: Error code.
OnExtensionAccessErrorType = void Function(String extensionName, String msg)
extensionName: The name of extension.
OnFaceDetectResultType = void Function(FaceDetectionResult result)
result: Face detection results.
OnFirstLocalAudioFrameType = void Function(StreamIndex index)
index: Type of the audio stream.
OnFirstLocalVideoFrameCapturedType = void Function(StreamIndex streamIndex, VideoFrameInfo videoFrameInfo)
streamIndex: Stream type.
OnFirstPublicStreamAudioFrameType = void Function(String publicStreamId)
publicStreamId: Public stream ID.
OnFirstPublicStreamVideoFrameDecodedType = void Function(String publicStreamId, VideoFrameInfo videoFrameInfo)
publicStreamId: Public stream ID.
OnFirstRemoteAudioFrameType = void Function(RemoteStreamKey streamKey)
streamKey: Information about the remote audio stream.
OnFirstRemoteVideoFrameRenderedType = void Function(RemoteStreamKey streamKey, VideoFrameInfo videoFrameInfo)
streamKey: Information about the remote stream.
OnForwardStreamEventType = void Function(List<ForwardStreamEventInfo> eventInfos)
eventInfos: List of target room events.
OnForwardStreamStateChangedType = void Function(List<ForwardStreamStateInfo> stateInfos)
stateInfos: List of target room information.
OnGetPeerOnlineStatusType = void Function(String peerUid, UserOnlineStatus status)
peerUid: ID of the user to be queried.
OnHardwareEchoDetectionResultType = void Function(HardwareEchoDetectionResult result)
result: Callback that notifies you the result of the echo detection before a call.
OnHttpProxyStateType = void Function(int state)
state: Current HTTP proxy connection status.
OnHttpsProxyStateType = void Function(int state)
state: Current HTTPS proxy connection status.
OnLeaveRoomType = void Function(RTCRoomStats stats)
stats: Statistics of this call.
OnLicenseWillExpireType = void Function(int days)
days: Expiration time in days.
OnLocalAudioPropertiesReportType = void Function(List<LocalAudioPropertiesInfo> audioPropertiesInfos)
audioPropertiesInfos: Local audio information.
OnLocalAudioStateChangedType = void Function(LocalAudioStreamState state, LocalAudioStreamError error)
state: Status of local audio device.
OnLocalProxyStateChangedType = void Function(LocalProxyType localProxyType, LocalProxyState localProxyState, LocalProxyError localProxyError)
localProxyType: Types of local proxy.
OnLocalVideoSizeChangedType = void Function(StreamIndex streamIndex, VideoFrameInfo videoFrameInfo)
streamIndex: Stream type.
OnLoginResultType = void Function(String uid, LoginErrorCode errorCode, int elapsed)
uid: ID of the logged-in user.
OnLogoutType = void Function(LogoutReason reason)
reason: The reason why users logout.
OnMediaFramePlayStateChangedType = void Function(String roomId, UserInfo userInfo, FirstFramePlayState state)
roomId: ID of the room which the stream publisher is in.
OnMediaFrameSendStateChangedType = void Function(String roomId, UserInfo userInfo, FirstFrameSendState state)
roomId: ID of the room from which the stream is published.
OnMediaPlayerPlayingProgressType = void Function(int playerId, int progress)
playerId: The ID of RTCMediaPlayer, set by calling RTCVideo.getMediaPlayer.
OnMediaPlayerStateChangedType = void Function(int playerId, PlayerState state, PlayerError error)
playerId: The ID of RTCMediaPlayer, set by calling RTCVideo.getMediaPlayer.
OnMixingEventType = void Function(MixedStreamEvent eventType, String taskId, MixedStreamErrorCode error, MixedStreamType mixType)
eventType: Task status.
OnNetworkDetectionResultType = void Function(NetworkDetectionLinkType type, NetworkQuality quality, int rtt, double lostRate, int bitrate, int jitter)
type: Indicating the network is uplink or downlink.
OnNetworkDetectionStoppedType = void Function(NetworkDetectionStopReason reason)
reason: Reason for stopping detection.
OnNetworkTypeChangedType = void Function(NetworkType type)
type: Current network connection type.
OnPerformanceAlarmsType = void Function(PerformanceAlarmMode mode, String roomId, PerformanceAlarmReason reason, SourceWantedData data)
mode: Indicates whether publish fallback is enabled locally.
OnPlayPublicStreamResultType = void Function(String publicStreamId, PublicStreamErrorCode errorCode)
publicStreamId: Public stream ID.
OnPublicStreamDataMessageReceivedType = void Function(String publicStreamId, Uint8List message, DataMessageSourceType sourceType)
publicStreamId: Public stream ID.
OnPushPublicStreamResultType = void Function(String roomId, String publicStreamId, PublicStreamErrorCode errorCode)
roomId: ID of the room where the public stream is published.
OnRecordingProgressUpdateType = void Function(StreamIndex type, RecordingProgress progress, RecordingInfo info)
type: Types of recorded streams.
OnRecordingStateUpdateType = void Function(StreamIndex type, RecordingState state, RecordingErrorCode errorCode, RecordingInfo info)
type: Types of recorded streams.
OnRemoteAudioPropertiesReportType = void Function(List<RemoteAudioPropertiesInfo> audioPropertiesInfos, int totalRemoteVolume)
audioPropertiesInfos: Remote audio information.
OnRemoteVideoSizeChangedType = void Function(RemoteStreamKey streamKey, VideoFrameInfo videoFrameInfo)
streamKey: Remote stream information.
OnRoomExtraInfoUpdateType = void Function(String key, String value, String lastUpdateUserId, int lastUpdateTimeMs)
key: Key of the extra information.
OnRoomMessageSendResultType = void Function(int msgid, RoomMessageSendResult error)
msgid: ID of this message.
OnRoomStateChangedType = void Function(String roomId, String uid, int state, String extraInfo)
roomId: ID of the room where the status change occurred.
OnSEIMessageReceivedType = void Function(RemoteStreamKey streamKey, Uint8List message)
streamKey: Including the SEI sender's username, room name and media stream.
OnSEIStreamUpdateType = void Function(RemoteStreamKey streamKey, SEIStreamUpdateEvent event)
streamKey: Remote stream information.
OnServerMessageSendResultType = void Function(int msgid, UserMessageSendResult error, Uint8List message)
msgid: ID of this message.
OnServerParamsSetResultType = void Function(int error)
error: Setting result
OnSetRoomExtraInfoResultType = void Function(int taskId, SetRoomExtraInfoResult error)
taskId: The task ID of the API call.
OnSimulcastSubscribeFallbackType = void Function(RemoteStreamSwitch event)
event: Information on changes in audio and video streams.
OnSocks5ProxyStateType = void Function(int state, String cmd, String proxyAddress, String localAddress, String remoteAddress)
state: Current SOCKS5 proxy connection status.
OnStreamMixingEventType = void Function(StreamMixingEvent eventType, String taskId, TranscoderErrorCode error, StreamMixingType mixType)
eventType: Task status.
OnStreamPushEventType = void Function(StreamSinglePushEvent eventType, String taskId, int error)
eventType: Task status
OnStreamSyncInfoReceivedType = void Function(RemoteStreamKey streamKey, SyncInfoStreamType streamType, Uint8List data)
streamKey: Remote stream information.
OnSubtitleMessageReceivedType = void Function(List<SubtitleMessage> subtitles)
subtitles: Subtitle messages.
OnSubtitleStateChangedType = void Function(SubtitleState state, SubtitleErrorCode errorCode, String errorMessage)
state: The states of subtitles.
OnUserJoinedType = void Function(UserInfo userInfo, int elapsed)
userInfo: User information.
OnUserLeaveType = void Function(String uid, UserOfflineReason reason)
uid: ID of the remote user who left the room or switched to invisible.
OnUserOperateMediaCaptureType = void Function(String roomId, String uid)
roomId: The ID of the room where the remote user who enables/disables media capturing is in.
OnUserPublishStreamType = void Function(String uid, MediaStreamType type)
uid: ID of the remote user who publishes the stream.
OnUserUnpublishStreamType = void Function(String uid, MediaStreamType type, StreamRemoveReason reason)
uid: ID of the user whose stream is removed.
OnUserVisibilityChangedType = void Function(bool currentUserVisibility, UserVisibilityChangeError errorCode)
currentUserVisibility: Visibility of the current user.
OnVideoDeviceStateChangedType = void Function(String deviceId, VideoDeviceType deviceType, MediaDeviceState deviceState, MediaDeviceError deviceError)
deviceId: Device ID
OnVideoDeviceWarningType = void Function(String deviceId, VideoDeviceType deviceType, MediaDeviceWarning deviceWarning)
deviceId: Device ID
OnVideoStreamBannedType = void Function(String uid, bool banned)
uid: ID of the user of whom the published video stream is banned/unbanned.
OnWarningType = void Function(WarningCode code)
code: Warning code.