dingrtc
Version:
dingRTC web端 sdk
1,296 lines (1,294 loc) • 140 kB
TypeScript
import * as _dingrtc_shared from '@dingrtc/shared';
import { EventEmitter, Reporter, ILogger, VideoSendReport, AudioSendReport, VideoReceiveReport, AudioReceiveReport, AudioNetEQReport, BweReport, AudioDeviceBufferReport, DingRTCError, PromiseLikeObject, ResolutionInfo as ResolutionInfo$1, TrackMediaType as TrackMediaType$1 } from '@dingrtc/shared';
export { ErrorCodeAndMsgMap } from '@dingrtc/shared';
import * as _dingrtc_channel from '@dingrtc/channel';
import { DingRTCChannel, JoinParam as JoinParam$1, ISignal_msg, UserEventAction as UserEventAction$1 } from '@dingrtc/channel';
import { SessionDescription } from 'sdp-transform';
/** Namespace signal_msg. */
declare namespace signal_msg {
/** Properties of an AudioSsrcSpec. */
interface IAudioSsrcSpec {
/** AudioSsrcSpec ssrc */
ssrc?: number | null;
/** AudioSsrcSpec rtxSsrc */
rtxSsrc?: number | null;
}
/** Represents an AudioSsrcSpec. */
/** Properties of a SyncNotification. */
interface ISyncNotification {
/** SyncNotification streamsVer */
streamsVer?: number | null;
/** SyncNotification participantsVer */
participantsVer?: number | null;
/** SyncNotification conferenceVer */
conferenceVer?: number | null;
/** SyncNotification msgId */
msgId?: string | null;
/** SyncNotification tid */
tid?: string | null;
/** SyncNotification traceId */
traceId?: string | null;
}
/** Properties of a VideoSsrcSpec. */
interface IVideoSsrcSpec {
/** VideoSsrcSpec ssrc */
ssrc?: number | null;
/** VideoSsrcSpec rtxSsrc */
rtxSsrc?: number | null;
/** VideoSsrcSpec fecSsrc */
fecSsrc?: number | null;
}
/** Represents a VideoSsrcSpec. */
/** Properties of a MultiPcAdaptRequestInfo. */
interface IMultiPcAdaptRequestInfo {
/** MultiPcAdaptRequestInfo audioSsrcSpec */
audioSsrcSpec?: signal_msg.IAudioSsrcSpec[] | null;
/** MultiPcAdaptRequestInfo videoSsrcSpec */
videoSsrcSpec?: signal_msg.IVideoSsrcSpec[] | null;
}
/** Represents a MultiPcAdaptRequestInfo. */
/** Properties of an AudioStreamFormat. */
interface IAudioStreamFormat {
/** AudioStreamFormat codec */
codec?: string | null;
/** AudioStreamFormat sampleRate */
sampleRate?: number | null;
/** AudioStreamFormat channelNum */
channelNum?: number | null;
}
/** Represents an AudioStreamFormat. */
/** Properties of an AudioFormatPreference. */
interface IAudioFormatPreference {
/** AudioFormatPreference preferred */
preferred?: signal_msg.IAudioStreamFormat | null;
/** AudioFormatPreference optional */
optional?: signal_msg.IAudioStreamFormat[] | null;
}
/** Represents an AudioFormatPreference. */
/** Properties of an AudioStreamOptional. */
interface IAudioStreamOptional {
/** AudioStreamOptional format */
format?: signal_msg.IAudioStreamFormat[] | null;
}
/** Represents an AudioStreamOptional. */
/** Properties of a VideoStreamFormat. */
interface IVideoStreamFormat {
/** VideoStreamFormat codec */
codec?: string | null;
/** VideoStreamFormat profile */
profile?: string | null;
}
/** Represents a VideoStreamFormat. */
/** Properties of a VideoFormatPreference. */
interface IVideoFormatPreference {
/** VideoFormatPreference preferred */
preferred?: signal_msg.IVideoStreamFormat | null;
/** VideoFormatPreference optional */
optional?: signal_msg.IVideoStreamFormat[] | null;
}
/** Represents a VideoFormatPreference. */
/** Properties of a FormatPreference. */
interface IFormatPreference {
/** FormatPreference audio */
audio?: signal_msg.IAudioFormatPreference | null;
/** FormatPreference video */
video?: signal_msg.IVideoFormatPreference | null;
}
/** Represents a FormatPreference. */
/** Properties of a Resolution. */
interface IResolution {
/** Resolution width */
width?: number | null;
/** Resolution height */
height?: number | null;
}
/** Represents a Resolution. */
/** Properties of a VideoSsrcParameters. */
interface IVideoSsrcParameters {
/** VideoSsrcParameters ssrc */
ssrc?: number | null;
/** VideoSsrcParameters framerate */
framerate?: number | null;
/** VideoSsrcParameters resolution */
resolution?: signal_msg.IResolution | null;
/** VideoSsrcParameters maxBitrate */
maxBitrate?: number | null;
/** VideoSsrcParameters minBitrate */
minBitrate?: number | null;
/** VideoSsrcParameters active */
active?: boolean | null;
/** VideoSsrcParameters bitrate */
bitrate?: number | null;
/** VideoSsrcParameters tlayer */
tlayer?: number | null;
/** VideoSsrcParameters multiSlice */
multiSlice?: number | null;
/** VideoSsrcParameters keyFrameInterval */
keyFrameInterval?: number | null;
/** VideoSsrcParameters constantPpsid */
constantPpsid?: number | null;
/** VideoSsrcParameters rid */
rid?: string | null;
}
/** Represents a VideoSsrcParameters. */
/** Properties of a VideoParameters. */
interface IVideoParameters {
/** VideoParameters ssrc */
ssrc?: number | null;
/** VideoParameters resolution */
resolution?: signal_msg.IResolution | null;
/** VideoParameters framerate */
framerate?: number | null;
/** VideoParameters bitrate */
bitrate?: string | null;
/** VideoParameters multiSlice */
multiSlice?: number | null;
/** VideoParameters keyFrameInterval */
keyFrameInterval?: number | null;
/** VideoParameters constantPpsid */
constantPpsid?: number | null;
/** VideoParameters resolutionLevel */
resolutionLevel?: number | null;
}
/** Represents a VideoParameters. */
/** Properties of a GroupVersion. */
interface IGroupVersion {
/** GroupVersion id */
id?: string | null;
/** GroupVersion ver */
ver?: number | null;
}
/** Represents a GroupVersion. */
/** Properties of a StreamInfo. */
interface IStreamInfo {
/** StreamInfo type */
type?: string | null;
/** StreamInfo owner */
owner?: string | null;
/** StreamInfo attributesJsonStr */
attributesJsonStr?: string | null;
/** StreamInfo label */
label?: string | null;
/** StreamInfo createTime */
createTime?: number | null;
}
/** Represents a StreamInfo. */
/** Properties of a StreamVideoParameters. */
interface IStreamVideoParameters {
/** StreamVideoParameters resolution */
resolution?: signal_msg.IResolution | null;
/** StreamVideoParameters framerate */
framerate?: number | null;
/** StreamVideoParameters bitrate */
bitrate?: number | null;
/** StreamVideoParameters keyFrameInterval */
keyFrameInterval?: number | null;
/** StreamVideoParameters multiSlice */
multiSlice?: number | null;
/** StreamVideoParameters constantPpsid */
constantPpsid?: number | null;
}
/** Represents a StreamVideoParameters. */
/** Properties of a VideoStreamPara. */
interface IVideoStreamPara {
/** VideoStreamPara specs */
specs?: string[] | null;
/** VideoStreamPara resolution */
resolution?: signal_msg.IResolution[] | null;
/** VideoStreamPara framerate */
framerate?: number[] | null;
/** VideoStreamPara bitrate */
bitrate?: string[] | null;
/** VideoStreamPara keyFrameInterval */
keyFrameInterval?: number[] | null;
}
/** Represents a VideoStreamPara. */
/** Properties of a VideoStreamOptional. */
interface IVideoStreamOptional {
/** VideoStreamOptional format */
format?: signal_msg.IVideoStreamFormat[] | null;
/** VideoStreamOptional parameters */
parameters?: signal_msg.IVideoStreamPara | null;
}
/** Represents a VideoStreamOptional. */
/** Properties of a StreamAudioDesc. */
interface IStreamAudioDesc {
/** StreamAudioDesc trackId */
trackId?: string | null;
/** StreamAudioDesc msid */
msid?: string | null;
/** StreamAudioDesc status */
status?: string | null;
/** StreamAudioDesc format */
format?: signal_msg.IAudioStreamFormat | null;
/** StreamAudioDesc source */
source?: string | null;
/** StreamAudioDesc ssrc */
ssrc?: number[] | null;
/** StreamAudioDesc ssrcGroup */
ssrcGroup?: signal_msg.IAudioSsrcSpec[] | null;
/** StreamAudioDesc optional */
optional?: signal_msg.IAudioStreamOptional | null;
}
/** Represents a StreamAudioDesc. */
/** Properties of a StreamVideoDesc. */
interface IStreamVideoDesc {
/** StreamVideoDesc trackId */
trackId?: string | null;
/** StreamVideoDesc msid */
msid?: string | null;
/** StreamVideoDesc status */
status?: string | null;
/** StreamVideoDesc source */
source?: string | null;
/** StreamVideoDesc format */
format?: signal_msg.IVideoStreamFormat | null;
/** StreamVideoDesc ssrc */
ssrc?: number[] | null;
/** StreamVideoDesc ssrcGroup */
ssrcGroup?: signal_msg.IVideoSsrcSpec[] | null;
/** StreamVideoDesc parameters */
parameters?: signal_msg.IStreamVideoParameters | null;
/** StreamVideoDesc optional */
optional?: signal_msg.IVideoStreamOptional | null;
/** StreamVideoDesc highestResolutionLevel */
highestResolutionLevel?: number | null;
}
/** Represents a StreamVideoDesc. */
/** Properties of a StreamMediaDesc. */
interface IStreamMediaDesc {
/** StreamMediaDesc audio */
audio?: signal_msg.IStreamAudioDesc | null;
/** StreamMediaDesc video */
video?: signal_msg.IStreamVideoDesc | null;
}
/** Represents a StreamMediaDesc. */
/** Properties of a Stream. */
interface IStream {
/** Stream id */
id?: string | null;
/** Stream type */
type?: string | null;
/** Stream media */
media?: signal_msg.IStreamMediaDesc | null;
/** Stream info */
info?: signal_msg.IStreamInfo | null;
/** Stream version */
version?: number | null;
}
/** Represents a Stream. */
/** Properties of an OriginMsg. */
interface IOriginMsg {
/** OriginMsg type */
type?: string | null;
/** OriginMsg id */
id?: string | null;
}
/** Represents an OriginMsg. */
/** Properties of an ErrorMsg. */
interface IErrorMsg {
/** ErrorMsg id */
id?: string | null;
/** ErrorMsg code */
code?: number | null;
/** ErrorMsg msg */
msg?: string | null;
/** ErrorMsg origin */
origin?: signal_msg.IOriginMsg | null;
}
/** Represents an ErrorMsg. */
/** Properties of an ErrorMsgs. */
interface IErrorMsgs {
/** ErrorMsgs globalStatus */
globalStatus?: string | null;
/** ErrorMsgs detailStatus */
detailStatus?: signal_msg.IErrorMsg[] | null;
}
/** Represents an ErrorMsgs. */
/** DataType export enum. */
enum DataType {
DATA_TYPE_STREAM = 0,
DATA_TYPE_PARTICIPANTS = 1,
DATA_TYPE_CONFERENCE = 2,
DATA_TYPE_GROUP_LIST = 3,
DATA_TYPE_GROUP = 4
}
/** OptType export enum. */
enum OptType {
OPT_TYPE_ADD = 0,
OPT_TYPE_REMOVE = 1,
OPT_TYPE_UPDATE = 2
}
/** SyncResponseCode export enum. */
enum SyncResponseCode {
SYNC_OK = 0,
SYNC_PART_SUC = 10,
SYNC_DATA_SIZE_LIMITED = 11,
SYNC_NOT_SUPPORT_TYPE = 12,
SYNC_NOT_FOUND = 13,
SYNC_CHANNEL_NOT_EXIST = 14,
SYNC_INTERNAL_ERROR = 15
}
/** Properties of a GroupParticipant. */
interface IGroupParticipant {
/** GroupParticipant uid */
uid?: string | null;
/** GroupParticipant pid */
pid?: string | null;
/** GroupParticipant userData */
userData?: string | null;
}
/** Represents a GroupParticipant. */
/** Properties of a GroupAudioInfo. */
interface IGroupAudioInfo {
/** GroupAudioInfo label */
label?: string | null;
/** GroupAudioInfo audio */
audio?: signal_msg.IStream | null;
}
/** Represents a GroupAudioInfo. */
/** Properties of a GroupInfo. */
interface IGroupInfo {
/** GroupInfo id */
id?: string | null;
/** GroupInfo ver */
ver?: number | null;
/** GroupInfo participants */
participants?: signal_msg.IGroupParticipant[] | null;
/** GroupInfo audioInfo */
audioInfo?: signal_msg.IGroupAudioInfo | null;
/** GroupInfo properties */
properties?: signal_msg.IGroupProperty[] | null;
}
/** Properties of a GroupUpdateOpt. */
interface IGroupUpdateOpt {
/** GroupUpdateOpt updateAction */
updateAction?: signal_msg.GroupUpdate | null;
/** GroupUpdateOpt participants */
participants?: signal_msg.IGroupParticipant[] | null;
/** GroupUpdateOpt properties */
properties?: signal_msg.IGroupProperty[] | null;
}
/** Represents a GroupInfo. */
/** Properties of a SyncFullData. */
interface ISyncFullData {
/** SyncFullData ver */
ver?: number | null;
/** SyncFullData totalPages */
totalPages?: number | null;
/** SyncFullData pagingSeq */
pagingSeq?: number | null;
/** SyncFullData groupData */
groupData?: signal_msg.IGroupPagingData | null;
/** SyncFullData groupListData */
groupListData?: signal_msg.IGroupListPagingData | null;
}
/** Represents a SyncFullData. */
/** Properties of a GroupPagingData. */
interface IGroupPagingData {
/** GroupPagingData pagingSeq */
pagingSeq?: number | null;
/** GroupPagingData curPage */
curPage?: number | null;
/** GroupPagingData groupInfos */
groupInfos?: signal_msg.IGroupInfo[] | null;
}
/** Represents a GroupPagingData. */
/** Properties of a GroupListPagingData. */
interface IGroupListPagingData {
/** GroupListPagingData pagingSeq */
pagingSeq?: number | null;
/** GroupListPagingData curPage */
curPage?: number | null;
/** GroupListPagingData groupIds */
groupIds?: string[] | null;
}
/** Represents a GroupListPagingData. */
/** Properties of a SyncChangeLog. */
interface ISyncChangeLog {
/** SyncChangeLog groupListChangeLogs */
groupListChangeLogs?: signal_msg.IGroupListChangeLog[] | null;
/** SyncChangeLog groupChangeLogs */
groupChangeLogs?: signal_msg.IGroupChangeLog[] | null;
}
/** Represents a SyncChangeLog. */
/** Properties of a SyncDataRequest. */
interface ISyncDataRequest {
/** SyncDataRequest type */
type?: signal_msg.DataType | null;
/** SyncDataRequest id */
id?: string | null;
/** SyncDataRequest ver */
ver?: number | null;
/** SyncDataRequest forceFullSync */
forceFullSync?: boolean | null;
/** SyncDataRequest supportPagingSync */
supportPagingSync?: boolean | null;
}
/** Represents a SyncDataRequest. */
/** Properties of a SyncDataResponse. */
interface ISyncDataResponse {
/** SyncDataResponse code */
code?: signal_msg.SyncResponseCode | null;
/** SyncDataResponse errMsg */
errMsg?: string | null;
/** SyncDataResponse fullSync */
fullSync?: signal_msg.ISyncFullData | null;
/** SyncDataResponse changeLogs */
changeLogs?: signal_msg.ISyncChangeLog[] | null;
}
/** Represents a SyncDataResponse. */
/** Properties of a SyncIds. */
interface ISyncIds {
/** SyncIds id */
id?: string | null;
/** SyncIds ver */
ver?: number | null;
}
/** Represents a SyncIds. */
/** Properties of a SyncDataByIdsRequest. */
interface ISyncDataByIdsRequest {
/** SyncDataByIdsRequest type */
type?: signal_msg.DataType | null;
/** SyncDataByIdsRequest ids */
ids?: signal_msg.ISyncIds[] | null;
/** SyncDataByIdsRequest forceFullSync */
forceFullSync?: boolean | null;
/** SyncDataByIdsRequest supportPagingSync */
supportPagingSync?: boolean | null;
}
/** Represents a SyncDataByIdsRequest. */
/** Properties of a SyncDataByIdsResponse. */
interface ISyncDataByIdsResponse {
/** SyncDataByIdsResponse code */
code?: signal_msg.SyncResponseCode | null;
/** SyncDataByIdsResponse errMsg */
errMsg?: string | null;
/** SyncDataByIdsResponse notFoundIds */
notFoundIds?: string[] | null;
/** SyncDataByIdsResponse fullSync */
fullSync?: signal_msg.ISyncFullData | null;
/** SyncDataByIdsResponse changeLogs */
changeLogs?: signal_msg.ISyncChangeLog[] | null;
}
/** Represents a SyncDataByIdsResponse. */
/** GroupUpdate export enum. */
enum GroupUpdate {
GROUP_UPDATE_AUDIO_STREAM_LOST = 0,
GROUP_UPDATE_AUDIO_STREAM_RECOVER = 1,
GROUP_UPDATE_ADD_PARTICIPANTS = 2,
GROUP_UPDATE_REMOVE_PARTICIPANTS = 3,
GROUP_UPDATE_SET_PROPERTIES = 4,
GROUP_UPDATE_REMOVE_PROPERTIES = 5
}
/** Properties of a GroupUpdateOpt. */
interface IGroupUpdateOpt {
/** GroupUpdateOpt updateAction */
updateAction?: signal_msg.GroupUpdate | null;
/** GroupUpdateOpt participants */
participants?: signal_msg.IGroupParticipant[] | null;
}
/** Represents a GroupUpdateOpt. */
/** Properties of a GroupChangeLog. */
interface IGroupChangeLog {
/** GroupChangeLog ver */
ver?: number | null;
/** GroupChangeLog type */
type?: signal_msg.OptType | null;
/** GroupChangeLog id */
id?: string | null;
/** GroupChangeLog groupInfo */
groupInfo?: signal_msg.IGroupInfo | null;
/** GroupChangeLog updateOpt */
updateOpt?: signal_msg.IGroupUpdateOpt | null;
/** GroupChangeLog msgId */
msgId?: string | null;
}
/** Represents a GroupChangeLog. */
/** GroupListUpdate export enum. */
enum GroupListUpdate {
GROUP_LIST_UPDATE_ADD_ID = 0,
GROUP_LIST_UPDATE_REMOVE_ID = 1
}
/** Properties of a GroupListUpdateOpt. */
interface IGroupListUpdateOpt {
/** GroupListUpdateOpt updateAction */
updateAction?: signal_msg.GroupListUpdate | null;
/** GroupListUpdateOpt id */
id?: string | null;
}
/** Represents a GroupListUpdateOpt. */
/** Properties of a GroupListChangeLog. */
interface IGroupListChangeLog {
/** GroupListChangeLog ver */
ver?: number | null;
/** GroupListChangeLog type */
type?: signal_msg.OptType | null;
/** GroupListChangeLog updateOpt */
updateOpt?: signal_msg.IGroupListUpdateOpt | null;
/** GroupListChangeLog msgId */
msgId?: string | null;
}
/** Properties of a SetGroupPropertiesRequest. */
interface ISetGroupPropertiesRequest {
/** SetGroupPropertiesRequest groupId */
groupId?: string | null;
/** SetGroupPropertiesRequest properties */
properties?: signal_msg.IGroupProperty[] | null;
}
/** Properties of a SetGroupPropertiesResponse. */
interface ISetGroupPropertiesResponse {
/** SetGroupPropertiesResponse code */
code?: number | null;
/** SetGroupPropertiesResponse errMsg */
errMsg?: string | null;
}
/** Properties of a RemoveGroupPropertiesRequest. */
interface IRemoveGroupPropertiesRequest {
/** RemoveGroupPropertiesRequest code */
groupId?: string | null;
/** RemoveGroupPropertiesRequest keys */
keys?: string[] | null;
}
/** Properties of a GroupProperty. */
interface IGroupProperty {
/** GroupProperty key */
key?: string | null;
/** GroupProperty value */
value?: string | null;
}
interface IRemoveGroupPropertiesResponse {
/** RemoveGroupPropertiesResponse code */
code?: number | null;
/** RemoveGroupPropertiesResponse errMsg */
errMsg?: string | null;
}
/** Represents a GroupListChangeLog. */
/** Properties of a JoinGroupRequest. */
interface IJoinGroupRequest {
/** JoinGroupRequest groupId */
groupId?: string | null;
/** JoinGroupRequest userData */
userData?: string | null;
/** JoinGroupRequest autoJoinGroupAudio */
autoJoinGroupAudio?: boolean | null;
/** JoinGroupRequest autoLeaveChannelAudio */
autoLeaveChannelAudio?: boolean | null;
}
/** Represents a JoinGroupRequest. */
/** Properties of a JoinGroupResponse. */
interface IJoinGroupResponse {
/** JoinGroupResponse code */
code?: number | null;
/** JoinGroupResponse errMsg */
errMsg?: string | null;
/** JoinGroupResponse group */
group?: signal_msg.IGroupInfo | null;
/** JoinGroupResponse joinGroupAudioSuccess */
joinGroupAudioSuccess?: boolean | null;
}
/** Represents a JoinGroupResponse. */
/** LEAVE_GROUP_REASON_CODE export enum. */
enum LEAVE_GROUP_REASON_CODE {
NORMAL_LEAVE = 0
}
/** Properties of a LeaveGroupRequest. */
interface ILeaveGroupRequest {
/** LeaveGroupRequest groupId */
groupId?: string | null;
/** LeaveGroupRequest reasonCode */
reasonCode?: signal_msg.LEAVE_GROUP_REASON_CODE | null;
/** LeaveGroupRequest autoJoinChannelAudio */
autoJoinChannelAudio?: boolean | null;
/** LeaveGroupRequest autoLeaveGroupAudio */
autoLeaveGroupAudio?: boolean | null;
}
/** Represents a LeaveGroupRequest. */
/** Properties of a LeaveGroupResponse. */
interface ILeaveGroupResponse {
/** LeaveGroupResponse code */
code?: number | null;
/** LeaveGroupResponse errMsg */
errMsg?: string | null;
/** LeaveGroupResponse joinChannelAudioSuccess */
joinChannelAudioSuccess?: (boolean | null);
}
/** Represents a LeaveGroupResponse. */
/** DismissGroupReasonCode export enum. */
enum DismissGroupReasonCode {
NORMAL_DISMISS = 0
}
/** Properties of a DismissGroupRequest. */
interface IDismissGroupRequest {
/** DismissGroupRequest groupId */
groupId?: string | null;
/** DismissGroupRequest reasonCode */
reasonCode?: signal_msg.DismissGroupReasonCode | null;
}
/** Represents a DismissGroupRequest. */
/** Properties of a DismissGroupResponse. */
interface IDismissGroupResponse {
/** DismissGroupResponse code */
code?: number | null;
/** DismissGroupResponse errMsg */
errMsg?: string | null;
}
/** Represents a DismissGroupResponse. */
/** Properties of an ObserveAllGroupsRequest. */
interface IObserveAllGroupsRequest {
}
/** Represents an ObserveAllGroupsRequest. */
/** Properties of an ObserveAllGroupsResponse. */
interface IObserveAllGroupsResponse {
/** ObserveAllGroupsResponse code */
code?: number | null;
/** ObserveAllGroupsResponse errMsg */
errMsg?: string | null;
}
/** Represents an ObserveAllGroupsResponse. */
/** Properties of an UnobserveAllGroupsRequest. */
interface IUnobserveAllGroupsRequest {
}
/** Represents an UnobserveAllGroupsRequest. */
/** Properties of an UnobserveAllGroupsResponse. */
interface IUnobserveAllGroupsResponse {
/** UnobserveAllGroupsResponse code */
code?: number | null;
/** UnobserveAllGroupsResponse errMsg */
errMsg?: string | null;
}
/** Represents an UnobserveAllGroupsResponse. */
/** Properties of a SetParticipantPropertiesRequest. */
interface ISetParticipantPropertiesRequest {
/** SetParticipantPropertiesRequest roomId */
roomId?: string | null;
/** SetParticipantPropertiesRequest participantId */
participantId?: string | null;
/** SetParticipantPropertiesRequest propertiesJsonStr */
propertiesJsonStr?: string | null;
/** SetParticipantPropertiesRequest tid */
tid?: string | null;
/** SetParticipantPropertiesRequest traceId */
traceId?: string | null;
}
/** Represents a SetParticipantPropertiesRequest. */
/** Properties of a RemoveParticipantPropertiesRequest. */
interface IRemoveParticipantPropertiesRequest {
/** RemoveParticipantPropertiesRequest roomId */
roomId?: string | null;
/** RemoveParticipantPropertiesRequest participantId */
participantId?: string | null;
/** RemoveParticipantPropertiesRequest propertiesJsonStr */
propertiesJsonStr?: string | null;
/** RemoveParticipantPropertiesRequest tid */
tid?: string | null;
/** RemoveParticipantPropertiesRequest traceId */
traceId?: string | null;
}
/** Represents a RemoveParticipantPropertiesRequest. */
/** Result export enum. */
enum Result {
Ok = 0,
Error = 1
}
/** Properties of a Response. */
interface IResponse {
/** Response result */
result?: signal_msg.Result | null;
/** Response tid */
tid?: string | null;
/** Response traceId */
traceId?: string | null;
/** Response code */
code?: number | null;
/** Response reason */
reason?: string | null;
/** Response createPeerConnectionResponse */
createPeerConnectionResponse?: signal_msg.ICreatePeerConnectionResponse | null;
/** Response errorMsg */
errorMsg?: signal_msg.IErrorMsgs | null;
/** Response queryStreamsVerResponse */
queryStreamsVerResponse?: signal_msg.IQueryStreamsVerResponse | null;
/** Response queryStreamsResponse */
queryStreamsResponse?: signal_msg.IQueryStreamsResponse | null;
/** Response publishResponse */
publishResponse?: signal_msg.IPublishResponse | null;
/** Response subscribeResponse */
subscribeResponse?: signal_msg.ISubscribeResponse | null;
/** Response joinGroupResponse */
joinGroupResponse?: signal_msg.IJoinGroupResponse | null;
/** Response leaveGroupResponse */
leaveGroupResponse?: signal_msg.ILeaveGroupResponse | null;
/** Response dismissGroupResponse */
dismissGroupResponse?: signal_msg.IDismissGroupResponse | null;
/** Response observeAllGroupsResponse */
observeAllGroupsResponse?: signal_msg.IObserveAllGroupsResponse | null;
/** Response unobserveAllGroupsResponse */
unobserveAllGroupsResponse?: signal_msg.IUnobserveAllGroupsResponse | null;
/** Response syncDataResponse */
syncDataResponse?: signal_msg.ISyncDataResponse | null;
/** Response syncDataByIdsResponse */
syncDataByIdsResponse?: signal_msg.ISyncDataByIdsResponse | null;
setGroupPropertiesResponse?: signal_msg.ISetGroupPropertiesResponse | null;
}
/** Represents a Response. */
/** Properties of a NotificationItem. */
interface INotificationItem {
/** NotificationItem event */
event?: string | null;
/** NotificationItem streamNotification */
streamNotification?: signal_msg.IStreamNotification | null;
/** NotificationItem serverFailoverNotification */
serverFailoverNotification?: signal_msg.IServerFailoverNotification | null;
/** NotificationItem progressNotification */
progressNotification?: signal_msg.IProgressNotification | null;
/** NotificationItem groupNotification */
groupNotification?: signal_msg.IGroupChangeLog | null;
/** NotificationItem groupListNotification */
groupListNotification?: signal_msg.IGroupListChangeLog | null;
}
/** Represents a NotificationItem. */
/** Properties of a BatchNotification. */
interface IBatchNotification {
/** BatchNotification notificationItem */
notificationItem?: signal_msg.INotificationItem[] | null;
/** BatchNotification tid */
tid?: string | null;
/** BatchNotification traceId */
traceId?: string | null;
}
/** Represents a BatchNotification. */
/** Properties of a MediaMessage. */
interface IMediaMessage {
/** MediaMessage payload */
payload?: string | null;
}
/** Represents a MediaMessage. */
/** Properties of an AudioStreamTrackDesc. */
interface IAudioStreamTrackDesc {
/** AudioStreamTrackDesc streamId */
streamId?: string | null;
/** AudioStreamTrackDesc trackId */
trackId?: string | null;
/** AudioStreamTrackDesc msid */
msid?: string | null;
/** AudioStreamTrackDesc source */
source?: string | null;
/** AudioStreamTrackDesc uplinkSsrcGroup */
uplinkSsrcGroup?: signal_msg.IAudioSsrcSpec[] | null;
/** AudioStreamTrackDesc format */
format?: signal_msg.IAudioStreamFormat | null;
/** AudioStreamTrackDesc autoMix */
autoMix?: string[] | null;
/** AudioStreamTrackDesc attributesJsonString */
attributesJsonString?: string | null;
}
/** Represents an AudioStreamTrackDesc. */
/** Properties of a VideoStreamTrackDesc. */
interface IVideoStreamTrackDesc {
/** VideoStreamTrackDesc streamId */
streamId?: string | null;
/** VideoStreamTrackDesc trackId */
trackId?: string | null;
/** VideoStreamTrackDesc msid */
msid?: string | null;
/** VideoStreamTrackDesc source */
source?: string | null;
/** VideoStreamTrackDesc logicSsrc */
logicSsrc?: number[] | null;
/** VideoStreamTrackDesc uplinkSsrcGroup */
uplinkSsrcGroup?: signal_msg.IVideoSsrcSpec[] | null;
/** VideoStreamTrackDesc ssrcParameters */
ssrcParameters?: signal_msg.IVideoSsrcParameters[] | null;
/** VideoStreamTrackDesc streamParameters */
streamParameters?: signal_msg.IVideoParameters | null;
/** VideoStreamTrackDesc attributesJsonString */
attributesJsonString?: string | null;
/** VideoStreamTrackDesc forwardOnly */
forwardOnly?: boolean | null;
/** VideoStreamTrackDesc mid */
mid?: string | null;
/** VideoStreamTrackDesc highestResolutionLevel */
highestResolutionLevel?: number | null;
}
/** Represents a VideoStreamTrackDesc. */
/** Properties of a MediaStreamTrackDesc. */
interface IMediaStreamTrackDesc {
/** MediaStreamTrackDesc audio */
audio?: signal_msg.IAudioStreamTrackDesc[] | null;
/** MediaStreamTrackDesc video */
video?: signal_msg.IVideoStreamTrackDesc[] | null;
}
/** Represents a MediaStreamTrackDesc. */
/** Properties of a StreamVersion. */
interface IStreamVersion {
/** StreamVersion streamId */
streamId?: string | null;
/** StreamVersion streamVer */
streamVer?: number | null;
}
/** Represents a StreamVersion. */
/** Properties of a StreamData. */
interface IStreamData {
/** StreamData id */
id?: string | null;
/** StreamData stream */
stream?: signal_msg.IStream | null;
}
/** Represents a StreamData. */
/** Properties of an AudioPubOptions. */
interface IAudioPubOptions {
/** AudioPubOptions source */
source?: string | null;
/** AudioPubOptions format */
format?: signal_msg.IAudioStreamFormat | null;
/** AudioPubOptions autoMix */
autoMix?: string[] | null;
}
/** Represents an AudioPubOptions. */
/** Properties of a VideoPubOptions. */
interface IVideoPubOptions {
/** VideoPubOptions source */
source?: string | null;
/** VideoPubOptions format */
format?: signal_msg.IVideoStreamFormat | null;
/** VideoPubOptions parameters */
parameters?: signal_msg.IVideoParameters | null;
/** VideoPubOptions forwardOnly */
forwardOnly?: boolean | null;
}
/** Represents a VideoPubOptions. */
/** Properties of a MediaPubOptionsSpecify. */
interface IMediaPubOptionsSpecify {
/** MediaPubOptionsSpecify audio */
audio?: signal_msg.IAudioPubOptions | null;
/** MediaPubOptionsSpecify video */
video?: signal_msg.IVideoPubOptions | null;
}
/** Represents a MediaPubOptionsSpecify. */
/** Properties of a BatchPublishRequest. */
interface IBatchPublishRequest {
/** BatchPublishRequest roomId */
roomId?: string | null;
/** BatchPublishRequest participantId */
participantId?: string | null;
/** BatchPublishRequest connectionId */
connectionId?: string | null;
/** BatchPublishRequest type */
type?: string | null;
/** BatchPublishRequest simulcast */
simulcast?: boolean | null;
/** BatchPublishRequest simulcastVersion */
simulcastVersion?: string | null;
/** BatchPublishRequest supportTemporalLayer */
supportTemporalLayer?: boolean | null;
/** BatchPublishRequest clientType */
clientType?: string | null;
/** BatchPublishRequest clientVersion */
clientVersion?: string | null;
/** BatchPublishRequest media */
media?: signal_msg.IMediaStreamTrackDesc | null;
/** BatchPublishRequest event */
event?: string | null;
/** BatchPublishRequest tid */
tid?: string | null;
/** BatchPublishRequest traceId */
traceId?: string | null;
}
/** Represents a BatchPublishRequest. */
/** Properties of a BatchUnpublishRequest. */
interface IBatchUnpublishRequest {
/** BatchUnpublishRequest roomId */
roomId?: string | null;
/** BatchUnpublishRequest participantId */
participantId?: string | null;
/** BatchUnpublishRequest connectionId */
connectionId?: string | null;
/** BatchUnpublishRequest audio */
audio?: string[] | null;
/** BatchUnpublishRequest video */
video?: string[] | null;
/** BatchUnpublishRequest tid */
tid?: string | null;
/** BatchUnpublishRequest traceId */
traceId?: string | null;
}
/** Represents a BatchUnpublishRequest. */
/** Properties of a QueryStreamsVerRequest. */
interface IQueryStreamsVerRequest {
/** QueryStreamsVerRequest roomId */
roomId?: string | null;
/** QueryStreamsVerRequest participantId */
participantId?: string | null;
/** QueryStreamsVerRequest streamIds */
streamIds?: string[] | null;
/** QueryStreamsVerRequest tid */
tid?: string | null;
/** QueryStreamsVerRequest traceId */
traceId?: string | null;
}
/** Represents a QueryStreamsVerRequest. */
/** Properties of a QueryStreamsVerResponse. */
interface IQueryStreamsVerResponse {
/** QueryStreamsVerResponse streamVersions */
streamVersions?: signal_msg.IStreamVersion[] | null;
/** QueryStreamsVerResponse totalVer */
totalVer?: number | null;
/** QueryStreamsVerResponse msg */
msg?: string | null;
}
/** Represents a QueryStreamsVerResponse. */
/** Properties of a StreamControlRequest. */
interface IStreamControlRequest {
/** StreamControlRequest roomId */
roomId?: string | null;
/** StreamControlRequest participantId */
participantId?: string | null;
/** StreamControlRequest streamId */
streamId?: string | null;
/** StreamControlRequest operation */
operation?: string | null;
/** StreamControlRequest data */
data?: string | null;
/** StreamControlRequest tid */
tid?: string | null;
/** StreamControlRequest traceId */
traceId?: string | null;
/** StreamControlRequest highestResolutionLevel */
highestResolutionLevel?: number | null;
}
/** Represents a StreamControlRequest. */
/** Properties of a QueryStreamsRequest. */
interface IQueryStreamsRequest {
/** QueryStreamsRequest roomId */
roomId?: string | null;
/** QueryStreamsRequest participantId */
participantId?: string | null;
/** QueryStreamsRequest streamIds */
streamIds?: string[] | null;
/** QueryStreamsRequest tid */
tid?: string | null;
/** QueryStreamsRequest traceId */
traceId?: string | null;
}
/** Represents a QueryStreamsRequest. */
/** Properties of a QueryStreamsResponse. */
interface IQueryStreamsResponse {
/** QueryStreamsResponse totalVer */
totalVer?: number | null;
/** QueryStreamsResponse msg */
msg?: string | null;
/** QueryStreamsResponse streams */
streams?: signal_msg.IStreamData[] | null;
}
/** Represents a QueryStreamsResponse. */
/** Properties of a SetStreamPropertiesRequest. */
interface ISetStreamPropertiesRequest {
/** SetStreamPropertiesRequest roomId */
roomId?: string | null;
/** SetStreamPropertiesRequest streamId */
streamId?: string | null;
/** SetStreamPropertiesRequest propertiesJsonStr */
propertiesJsonStr?: string | null;
/** SetStreamPropertiesRequest tid */
tid?: string | null;
/** SetStreamPropertiesRequest traceId */
traceId?: string | null;
}
/** Represents a SetStreamPropertiesRequest. */
/** Properties of a PublishRequest. */
interface IPublishRequest {
/** PublishRequest roomId */
roomId?: string | null;
/** PublishRequest participantId */
participantId?: string | null;
/** PublishRequest type */
type?: string | null;
/** PublishRequest event */
event?: string | null;
/** PublishRequest media */
media?: signal_msg.IMediaPubOptionsSpecify | null;
/** PublishRequest attributesJsonStr */
attributesJsonStr?: string | null;
/** PublishRequest tid */
tid?: string | null;
/** PublishRequest traceId */
traceId?: string | null;
}
/** Represents a PublishRequest. */
/** Properties of a PublishResponse. */
interface IPublishResponse {
/** PublishResponse id */
id?: string | null;
}
/** Represents a PublishResponse. */
/** Properties of an UnpublishRequest. */
interface IUnpublishRequest {
/** UnpublishRequest roomId */
roomId?: string | null;
/** UnpublishRequest participantId */
participantId?: string | null;
/** UnpublishRequest streamId */
streamId?: string | null;
/** UnpublishRequest tid */
tid?: string | null;
/** UnpublishRequest traceId */
traceId?: string | null;
}
/** Represents an UnpublishRequest. */
/** Properties of a NetworkHealth. */
interface INetworkHealth {
/** NetworkHealth receiving */
receiving?: boolean | null;
/** NetworkHealth lossRate */
lossRate?: number | null;
/** NetworkHealth timestamp */
timestamp?: number | null;
/** NetworkHealth cutoff */
cutoff?: boolean | null;
/** NetworkHealth tid */
tid?: string | null;
}
/** Represents a NetworkHealth. */
/** Properties of a StreamMsg. */
interface IStreamMsg {
/** StreamMsg field */
field?: string | null;
/** StreamMsg streamVer */
streamVer?: number | null;
/** StreamMsg expiredMs */
expiredMs?: number | null;
/** StreamMsg extraValue */
extraValue?: string[] | null;
/** StreamMsg tid */
tid?: string | null;
/** StreamMsg networkHealth */
networkHealth?: signal_msg.INetworkHealth | null;
/** StreamMsg streamStatus */
streamStatus?: string | null;
/** StreamMsg stream */
stream?: signal_msg.IStream | null;
/** StreamMsg activeStream */
activeStream?: string | null;
/** StreamMsg propertiesJsonStr */
propertiesJsonStr?: string | null;
/** StreamMsg highestResolutionLevel */
highestResolutionLevel?: number | null;
}
/** Represents a StreamMsg. */
/** Properties of a StreamNotification. */
interface IStreamNotification {
/** StreamNotification streamId */
streamId?: string | null;
/** StreamNotification status */
status?: string | null;
/** StreamNotification totalVer */
totalVer?: number | null;
/** StreamNotification msgId */
msgId?: string | null;
/** StreamNotification ts */
ts?: number | null;
/** StreamNotification tid */
tid?: string | null;
/** StreamNotification traceId */
traceId?: string | null;
/** StreamNotification stream */
stream?: signal_msg.IStream | null;
/** StreamNotification msg */
msg?: signal_msg.IStreamMsg | null;
}
/** Represents a StreamNotification. */
/** Properties of a Candidate. */
interface ICandidate {
/** Candidate candidate */
candidate?: string | null;
/** Candidate sdpMlineIndex */
sdpMlineIndex?: number | null;
/** Candidate sdpMid */
sdpMid?: string | null;
}
/** Represents a Candidate. */
/** Properties of a SessionSignaling. */
interface ISessionSignaling {
/** SessionSignaling type */
type?: string | null;
/** SessionSignaling sdp */
sdp?: string | null;
/** SessionSignaling candidate */
candidate?: signal_msg.ICandidate | null;
/** SessionSignaling optionsJsonStr */
optionsJsonStr?: string | null;
}
/** Represents a SessionSignaling. */
/** Properties of a SignalingData. */
interface ISignalingData {
/** SignalingData type */
type?: string | null;
/** SignalingData sdp */
sdp?: string | null;
}
/** Represents a SignalingData. */
/** Properties of a CreatePeerConnectionRequest. */
interface ICreatePeerConnectionRequest {
/** CreatePeerConnectionRequest roomId */
roomId?: string | null;
/** CreatePeerConnectionRequest participantId */
participantId?: string | null;
/** CreatePeerConnectionRequest connectionId */
connectionId?: string | null;
/** CreatePeerConnectionRequest tid */
tid?: string | null;
/** CreatePeerConnectionRequest event */
event?: string | null;
/** CreatePeerConnectionRequest direction */
direction?: string | null;
/** CreatePeerConnectionRequest sdpOffer */
sdpOffer?: string | null;
/** CreatePeerConnectionRequest type */
type?: string | null;
/** CreatePeerConnectionRequest isOca */
isOca?: boolean | null;
/** CreatePeerConnectionRequest isFailover */
isFailover?: boolean | null;
/** CreatePeerConnectionRequest multiPcAdaptInfo */
multiPcAdaptInfo?: signal_msg.IMultiPcAdaptRequestInfo | null;
/** CreatePeerConnectionRequest pcFormatPreference */
pcFormatPreference?: signal_msg.IFormatPreference | null;
/** CreatePeerConnectionRequest optionsJsonStr */
optionsJsonStr?: string | null;
/** CreatePeerConnectionRequest traceId */
traceId?: string | null;
/** CreatePeerConnectionRequest sfuSsrcGroup */
sfuSsrcGroup?: signal_msg.IAudioSsrcSpec[] | null;
}
/** Represents a CreatePeerConnectionRequest. */
/** Properties of a CreatePeerConnectionResponse. */
interface ICreatePeerConnectionResponse {
/** CreatePeerConnectionResponse connectionId */
connectionId?: string | null;
/** CreatePeerConnectionResponse sdpAnswer */
sdpAnswer?: string | null;
}
/** Represents a CreatePeerConnectionResponse. */
/** Properties of a ClosePeerConnectionRequest. */
interface IClosePeerConnectionRequest {
/** ClosePeerConnectionRequest roomId */
roomId?: string | null;
/** ClosePeerConnectionRequest participantId */
participantId?: string | null;
/** ClosePeerConnectionRequest connectionId */
connectionId?: string | null;
/** ClosePeerConnectionRequest direction */
direction?: string | null;
/** ClosePeerConnectionRequest tid */
tid?: string | null;
/** ClosePeerConnectionRequest traceId */
traceId?: string | null;
}
/** Represents a ClosePeerConnectionRequest. */
/** Properties of a SoacRequest. */
interface ISoacRequest {
/** SoacRequest id */
id?: string | null;
/** SoacRequest signaling */
signaling?: signal_msg.ISessionSignaling | null;
/** SoacRequest tid */
tid?: string | null;
/** SoacRequest traceId */
traceId?: string | null;
}
/** Represents a SoacRequest. */
/** Properties of a NotifyAction. */
interface INotifyAction {
/** NotifyAction actionName */
actionName?: string | null;
/** NotifyAction connectionId */
connectionId?: string | null;
/** NotifyAction traceId */
traceId?: string | null;
}
/** Represents a NotifyAction. */
/** Properties of a ServerFailoverNotification. */
interface IServerFailoverNotification {
/** ServerFailoverNotification actions */
actions?: signal_msg.INotifyAction[] | null;
/** ServerFailoverNotification msgId */
msgId?: string | null;
/** ServerFailoverNotification tid */
tid?: string | null;
/** ServerFailoverNotification traceId */
traceId?: string | null;
}
/** Represents a ServerFailoverNotification. */
/** Properties of a ProgressNotification. */
interface IProgressNotification {
/** ProgressNotification id */
id?: string | null;
/** ProgressNotification status */
status?: string | null;
/** ProgressNotification data */
data?: signal_msg.ISignalingData | null;
/** ProgressNotification msgId */
msgId?: string | null;
/** ProgressNotification tid */
tid?: string | null;
/** ProgressNotification traceId */
traceId?: string | null;
}
/** Represents a ProgressNotification. */
/** Properties of an AudioBatchSubOptions. */
interface IAudioBatchSubOptions {
/** AudioBatchSubOptions subscriptionId */
subscriptionId?: string | null;
/** AudioBatchSubOptions from */
from?: string | null;
/** AudioBatchSubOptions trackId */
trackId?: string | null;
/** AudioBatchSubOptions ssrcGroup */
ssrcGroup?: signal_msg.IAudioSsrcSpec[] | null;
/** AudioBatchSubOptions format */
format?: signal_msg.IAudioStreamFormat | null;
}
/** Represents an AudioBatchSubOptions. */
/** Properties of a VideoBatchSubOptions. */
interface IVideoBatchSubOptions {
/** VideoBatchSubOptions subscriptionId */
subscriptionId?: string | null;
/** VideoBatchSubOptions from */
from?: string | null;
/** VideoBatchSubOptions trackId */
trackId?: string | null;
/** VideoBatchSubOptions ssrcGroup */
ssrcGroup?: signal_msg.IVideoSsrcSpec[] | null;
/** VideoBatchSubOptions parameters */
parameters?: signal_msg.IVideoParameters | null;
/** VideoBatchSubOptions format */
format?: signal_msg.IVideoStreamFormat | null;
/** VideoBatchSubOptions subSsrcGroup */
subSsrcGroup?: signal_msg.IVideoSsrcSpec | null;
}
/** Represents a VideoBatchSubOptions. */
/** Properties of a MediaBatchSubOptions. */
interface IMediaBatchSubOptions {
/** MediaBatchSubOptions audio */
audio?: signal_msg.IAudioBatchSubOptions[] | null;
/** MediaBatchSubOptions video */
video?: signal_msg.IVideoBatchSubOptions[] | null;
}
/** Represents a MediaBatchSubOptions. */
/** Properties of an Audio. */
interface IAudio {
/** Audio from */
from?: string | null;
}
/** Represents an Audio. */
/** Properties of a Video. */
interface IVideo {
/** Video from */
from?: string | null;
/** Video params */
params?: signal_msg.IVideoParameters | null;
}
/** Represents a Video. */
/** Properties of a MediaUpdateDesc. */
interface IMediaUpdateDesc {