• Docs /
• RTC /
• Audio and Video SDK /
• Web /
• CloudHubRTCObject /

CloudHub JSSDK

• Overview
• CloudHubRTC
• CloudHubRTCObject
• Client
• ClientEvent
• ClientLiveTranscoding
• ClientChannelMediaRelayConfig
• Stream
• StreamEvent
• DeviceManager
• constant

CloudHubRTC Data object document

ClientConfig description

Define the interface of the config parameter in the createclient type Object.

Example:

var config = {}
var client = CloudHubRTC.createClient(config);

StreamSpec Description

Description: The interface that defines the spec parameter in createStream, type object.

Note: 1、According to the UID, Type, SourceID generating stream ID, stream ID format is: Uid: Type: SourceId 2、Multi-streaming mode and flow types are VIDEO (ie: type -> video), not allowed to be streaming audio and video at the same time, that is, the audio and video need to be released in multi-stream mode, and the SourceId of the audio must be Audio, video SourceId must be the device ID of the video.

Example:

var stream = CloudHubRTC.createStream({
    uid: "uid",
    type: "video",
    audio:true,
    video:true
});

LocalAudioStatsMap

A set of LocalaudioStats objects, each stream ID (SID) corresponds to a localaudioostats. After calling getLocalaudioStats, the SID and localaudiostats data of the local stream will be provided through the interface, and the type is Object.

Example:

{sid1:LocalAudioStats1, sid2:LocalAudioStats2}

LocalVideoStatsMap

A set of Localvideostats objects, each stream ID (SID) corresponds to a LocalVideostats. After calling getLocalVideoStats, the SID and Localvideostats data of the local stream will be provided through the interface, and the type is Object.

Example:

{sid1:LocalVideoStats1, sid2:LocalVideoStats2}

RemoteAudioStatsMap

A set of RemoteAudiostats objects, each stream ID (SID) corresponds to a RemoteAudioOstats. After calling the getRemoteAudioOstats, the remote streaming SID and RemoteAudioStats data are available through this interface, and the type is Object.

Example:

{sid1:RemoteAudioStats1, sid2:RemoteAudioStats2}

RemoteVideoStatsMap

A set of RemotevideStats objects, each stream ID (SID) corresponds to a Remotevideostats. After calling the GetRemotevideStats, the remote streaming SID and RemotevideStats data are provided through this interface, and the type Object is available.

Example:

{sid1:RemoteVideoStats1, sid2:RemoteVideoStats2}

MediaStreamTrack

Media stream track

This interface represents a media track in a stream, such as an audio orbit or a video track.

For more information, please refer to Browser MediaMtrack explain.

LocalStreamStats

Local video stream connection statistics

After the streaming of the local release is successful, the connection statistics will be provided through the interface.

structure:

{audio:{...audiostats}, video:{...videostats} }

RemoteStreamStats

Far audio video stream connection statistics

After the remote video stream is successful, the connection statistics will be provided through this interface.

structure:

{audio:{...audiostats}, video:{...videostats} }

LocalAudioStats

Local audio connection statistics

LocalVideoStats

Connection statistics for local video

StreamPlayError

Flow play error message

Calling the stream.playVideo / stream.playAudio method When playing the video stream / audio stream, you can understand the possible reasons.

Normally, call stream.playAudio fails In addition to errflag to “Abort _ERROR”, you can guide users to try to trigger video playback with gestures (calls Stream.Resumeaudio method).

Note:

1. Due to browser restrictions, Audio / Video’s Play may fail.
2. Browser Limits VIDEO / AUDIO Auto Play, please refer to Processing a browser automatic playback policy。
3. For more information, please refer to About AUDIO / Video Play。

NetworkQualityStats

Network quality statistics.

After the user adds the channel, the SDK will trigger a stream-network-quality callback every two seconds and provide network quality statistics through this interface.

structure:

{audio:{...audiostats}, video:{...videostats} }

MediaDeviceInfo

Media device information

After users join the channel, get the media device details, such as microphones, cameras, speakers, etc.

structure:

    {
        hasdevice: {
            audioinput: true
            audiooutput: true
            videoinput: true
        }, 
        devices: {  
            audioinput: [...]
            audiooutput: [...]
            videoinput: [...]
        }, 
        useDevices: {
            audioinput: "default"
            audiooutput: "default"
            videoinput:  "619bae7a5444acbba3268db78018f7649a92c13fcf2e1849d709ec0d0a16fc2a"  
        }
    }