@observertc/monitor-schemas
Version:
ObserveRTC Library for Schemas
1,172 lines (1,171 loc) • 136 kB
TypeScript
import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
import { Message } from "@bufbuild/protobuf";
/**
* @generated from message org.observertc.schemas.protobuf.Samples
*/
export declare class Samples extends Message<Samples> {
/**
* Samples taken from the client
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample clientSamples = 1;
*/
clientSamples: Samples_ClientSample[];
/**
* Samples taken from an Sfu
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.SfuSample sfuSamples = 2;
*/
sfuSamples: Samples_SfuSample[];
/**
* Samples taken from the TURN server
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.TurnSample turnSamples = 3;
*/
turnSamples: Samples_TurnSample[];
/**
* Additional control flags indicate various operation has to be performed
*
* @generated from field: optional org.observertc.schemas.protobuf.Samples.Controls controls = 4;
*/
controls?: Samples_Controls;
constructor(data?: PartialMessage<Samples>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples;
static equals(a: Samples | PlainMessage<Samples> | undefined, b: Samples | PlainMessage<Samples> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.Controls
*/
export declare class Samples_Controls extends Message<Samples_Controls> {
/**
* Holds a new claim to process
*
* @generated from field: optional string accessClaim = 1;
*/
accessClaim?: string;
/**
* Indicate that the server should close the connection
*
* @generated from field: optional bool close = 2;
*/
close?: boolean;
constructor(data?: PartialMessage<Samples_Controls>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.Controls";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_Controls;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_Controls;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_Controls;
static equals(a: Samples_Controls | PlainMessage<Samples_Controls> | undefined, b: Samples_Controls | PlainMessage<Samples_Controls> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample
*/
export declare class Samples_ClientSample extends Message<Samples_ClientSample> {
/**
* List of certificates the client provided
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.Certificate certificates = 1;
*/
certificates: Samples_ClientSample_Certificate[];
/**
* List of codec the client has
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.MediaCodecStats codecs = 2;
*/
codecs: Samples_ClientSample_MediaCodecStats[];
/**
* User provided custom call events
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.CustomCallEvent customCallEvents = 3;
*/
customCallEvents: Samples_ClientSample_CustomCallEvent[];
/**
* User provided custom call events
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.CustomObserverEvent customObserverEvents = 4;
*/
customObserverEvents: Samples_ClientSample_CustomObserverEvent[];
/**
* Measurements about the data channels currently avaialble on peer connections
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.DataChannel dataChannels = 5;
*/
dataChannels: Samples_ClientSample_DataChannel[];
/**
* The WebRTC app provided custom stats payload
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.ExtensionStat extensionStats = 6;
*/
extensionStats: Samples_ClientSample_ExtensionStat[];
/**
* Candidate pair stats
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceCandidatePair iceCandidatePairs = 7;
*/
iceCandidatePairs: Samples_ClientSample_IceCandidatePair[];
/**
* List of local ICE candidates
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceLocalCandidate iceLocalCandidates = 8;
*/
iceLocalCandidates: Samples_ClientSample_IceLocalCandidate[];
/**
* List of remote ICE candidates
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceRemoteCandidate iceRemoteCandidates = 9;
*/
iceRemoteCandidates: Samples_ClientSample_IceRemoteCandidate[];
/**
* The WebRTC app provided List of ICE server the client used.
*
* @generated from field: repeated string iceServers = 10;
*/
iceServers: string[];
/**
* List of compound measurements related to inbound audio tracks
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.InboundAudioTrack inboundAudioTracks = 11;
*/
inboundAudioTracks: Samples_ClientSample_InboundAudioTrack[];
/**
* List of compound measurements related to inbound video tracks
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.InboundVideoTrack inboundVideoTracks = 12;
*/
inboundVideoTracks: Samples_ClientSample_InboundVideoTrack[];
/**
* The local part of the Signal Description Protocol to establish connections
*
* @generated from field: repeated string localSDPs = 13;
*/
localSDPs: string[];
/**
* The WebRTC app provided List of the media constraints the client has.
*
* @generated from field: repeated string mediaConstraints = 14;
*/
mediaConstraints: string[];
/**
* The WebRTC app provided List of the media devices the client has.
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.MediaDevice mediaDevices = 15;
*/
mediaDevices: Samples_ClientSample_MediaDevice[];
/**
* WebRTC App provided information related to the operation system the client uses.
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.MediaSourceStat mediaSources = 16;
*/
mediaSources: Samples_ClientSample_MediaSourceStat[];
/**
* List of compound measurements related to outbound audio tracks
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.OutboundAudioTrack outboundAudioTracks = 17;
*/
outboundAudioTracks: Samples_ClientSample_OutboundAudioTrack[];
/**
* List of compound measurements related to outbound video tracks
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.OutboundVideoTrack outboundVideoTracks = 18;
*/
outboundVideoTracks: Samples_ClientSample_OutboundVideoTrack[];
/**
* Transport stats of Peer Connection
*
* @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.PeerConnectionTransport pcTransports = 19;
*/
pcTransports: Samples_ClientSample_PeerConnectionTransport[];
/**
* The WebRTC app provided List of user media errors the client has.
*
* @generated from field: repeated string userMediaErrors = 20;
*/
userMediaErrors: string[];
/**
* Unique id of the client providing samples. Must be a valid UUID
*
* @generated from field: required string clientId = 21;
*/
clientId?: string;
/**
* The timestamp the sample is created in GMT
*
* @generated from field: required uint32 timestamp = 22;
*/
timestamp?: number;
/**
* WebRTC App provided information related to the browser the client uses.
*
* @generated from field: optional org.observertc.schemas.protobuf.Samples.ClientSample.Browser browser = 23;
*/
browser?: Samples_ClientSample_Browser;
/**
* If it is provided the server uses the given id to match clients in the same call. Must be a valid UUID.
*
* @generated from field: optional string callId = 24;
*/
callId?: string;
/**
* WebRTC App provided information related to the engine the client uses.
*
* @generated from field: optional org.observertc.schemas.protobuf.Samples.ClientSample.Engine engine = 25;
*/
engine?: Samples_ClientSample_Engine;
/**
* Special marker for the samples
*
* @generated from field: optional string marker = 26;
*/
marker?: string;
/**
* WebRTC App provided information related to the operation system the client uses.
*
* @generated from field: optional org.observertc.schemas.protobuf.Samples.ClientSample.OperationSystem os = 27;
*/
os?: Samples_ClientSample_OperationSystem;
/**
* WebRTC App provided information related to the platform the client uses.
*
* @generated from field: optional org.observertc.schemas.protobuf.Samples.ClientSample.Platform platform = 28;
*/
platform?: Samples_ClientSample_Platform;
/**
* The WebRTC app configured room id the client joined for the call.
*
* @generated from field: optional string roomId = 29;
*/
roomId?: string;
/**
* The sequence number a source assigns to the sample. Every time the source make a sample at a client this number should be monothonically incremented.
*
* @generated from field: optional int32 sampleSeq = 30;
*/
sampleSeq?: number;
/**
* The offset from GMT in hours
*
* @generated from field: optional int32 timeZoneOffsetInHours = 31;
*/
timeZoneOffsetInHours?: number;
/**
* The WebRTC app configured human readable user id the client is joined.
*
* @generated from field: optional string userId = 32;
*/
userId?: string;
constructor(data?: PartialMessage<Samples_ClientSample>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample;
static equals(a: Samples_ClientSample | PlainMessage<Samples_ClientSample> | undefined, b: Samples_ClientSample | PlainMessage<Samples_ClientSample> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.Engine
*/
export declare class Samples_ClientSample_Engine extends Message<Samples_ClientSample_Engine> {
/**
* The name of the Engine
*
* @generated from field: optional string name = 1;
*/
name?: string;
/**
* The version of the engine
*
* @generated from field: optional string version = 2;
*/
version?: string;
constructor(data?: PartialMessage<Samples_ClientSample_Engine>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.Engine";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_Engine;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_Engine;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_Engine;
static equals(a: Samples_ClientSample_Engine | PlainMessage<Samples_ClientSample_Engine> | undefined, b: Samples_ClientSample_Engine | PlainMessage<Samples_ClientSample_Engine> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.Platform
*/
export declare class Samples_ClientSample_Platform extends Message<Samples_ClientSample_Platform> {
/**
* The name of the model
*
* @generated from field: optional string model = 1;
*/
model?: string;
/**
* The name of the platform
*
* @generated from field: optional string type = 2;
*/
type?: string;
/**
* The name of the vendor
*
* @generated from field: optional string vendor = 3;
*/
vendor?: string;
constructor(data?: PartialMessage<Samples_ClientSample_Platform>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.Platform";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_Platform;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_Platform;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_Platform;
static equals(a: Samples_ClientSample_Platform | PlainMessage<Samples_ClientSample_Platform> | undefined, b: Samples_ClientSample_Platform | PlainMessage<Samples_ClientSample_Platform> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.Browser
*/
export declare class Samples_ClientSample_Browser extends Message<Samples_ClientSample_Browser> {
/**
* The name of the operation system (e.g.: linux) the webrtc app uses
*
* @generated from field: optional string name = 1;
*/
name?: string;
/**
* The version of the operation system
*
* @generated from field: optional string version = 2;
*/
version?: string;
constructor(data?: PartialMessage<Samples_ClientSample_Browser>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.Browser";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_Browser;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_Browser;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_Browser;
static equals(a: Samples_ClientSample_Browser | PlainMessage<Samples_ClientSample_Browser> | undefined, b: Samples_ClientSample_Browser | PlainMessage<Samples_ClientSample_Browser> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.OperationSystem
*/
export declare class Samples_ClientSample_OperationSystem extends Message<Samples_ClientSample_OperationSystem> {
/**
* The name of the operation system (e.g.: linux) the webrtc app uses
*
* @generated from field: optional string name = 1;
*/
name?: string;
/**
* The version of the operation system
*
* @generated from field: optional string version = 2;
*/
version?: string;
/**
* The name of the version of the operation system
*
* @generated from field: optional string versionName = 3;
*/
versionName?: string;
constructor(data?: PartialMessage<Samples_ClientSample_OperationSystem>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.OperationSystem";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_OperationSystem;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_OperationSystem;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_OperationSystem;
static equals(a: Samples_ClientSample_OperationSystem | PlainMessage<Samples_ClientSample_OperationSystem> | undefined, b: Samples_ClientSample_OperationSystem | PlainMessage<Samples_ClientSample_OperationSystem> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.MediaDevice
*/
export declare class Samples_ClientSample_MediaDevice extends Message<Samples_ClientSample_MediaDevice> {
/**
* the provided id of the media input / output
*
* @generated from field: optional string id = 1;
*/
id?: string;
/**
* The media kind of the media device
*
* @generated from field: optional string kind = 2;
*/
kind?: string;
/**
* The name of the device
*
* @generated from field: optional string label = 3;
*/
label?: string;
constructor(data?: PartialMessage<Samples_ClientSample_MediaDevice>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.MediaDevice";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_MediaDevice;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaDevice;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaDevice;
static equals(a: Samples_ClientSample_MediaDevice | PlainMessage<Samples_ClientSample_MediaDevice> | undefined, b: Samples_ClientSample_MediaDevice | PlainMessage<Samples_ClientSample_MediaDevice> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.ExtensionStat
*/
export declare class Samples_ClientSample_ExtensionStat extends Message<Samples_ClientSample_ExtensionStat> {
/**
* The payload of the extension stats the custom app provides
*
* @generated from field: required string payload = 1;
*/
payload?: string;
/**
* The type of the extension stats the custom app provides
*
* @generated from field: required string type = 2;
*/
type?: string;
constructor(data?: PartialMessage<Samples_ClientSample_ExtensionStat>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.ExtensionStat";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_ExtensionStat;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_ExtensionStat;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_ExtensionStat;
static equals(a: Samples_ClientSample_ExtensionStat | PlainMessage<Samples_ClientSample_ExtensionStat> | undefined, b: Samples_ClientSample_ExtensionStat | PlainMessage<Samples_ClientSample_ExtensionStat> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.CustomCallEvent
*/
export declare class Samples_ClientSample_CustomCallEvent extends Message<Samples_ClientSample_CustomCallEvent> {
/**
* the name of the event used as identifier. (e.g.: MEDIA_TRACK_MUTED, USER_REJOINED, etc..)
*
* @generated from field: required string name = 1;
*/
name?: string;
/**
* Additional attachment relevant for the event
*
* @generated from field: optional string attachments = 2;
*/
attachments?: string;
/**
* The identifier of the media track the event is related to
*
* @generated from field: optional string mediaTrackId = 3;
*/
mediaTrackId?: string;
/**
* the human readable message of the event
*
* @generated from field: optional string message = 4;
*/
message?: string;
/**
* The unique identifier of the peer connection
*
* @generated from field: optional string peerConnectionId = 5;
*/
peerConnectionId?: string;
/**
* The EPOCH timestamp the event is generated
*
* @generated from field: optional uint32 timestamp = 6;
*/
timestamp?: number;
/**
* the value of the event
*
* @generated from field: optional string value = 7;
*/
value?: string;
constructor(data?: PartialMessage<Samples_ClientSample_CustomCallEvent>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.CustomCallEvent";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_CustomCallEvent;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_CustomCallEvent;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_CustomCallEvent;
static equals(a: Samples_ClientSample_CustomCallEvent | PlainMessage<Samples_ClientSample_CustomCallEvent> | undefined, b: Samples_ClientSample_CustomCallEvent | PlainMessage<Samples_ClientSample_CustomCallEvent> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.CustomObserverEvent
*/
export declare class Samples_ClientSample_CustomObserverEvent extends Message<Samples_ClientSample_CustomObserverEvent> {
/**
* the name of the event used as identifier. (e.g.: MEDIA_TRACK_MUTED, USER_REJOINED, etc..)
*
* @generated from field: required string name = 1;
*/
name?: string;
/**
* Additional attachment relevant for the event
*
* @generated from field: optional string attachments = 2;
*/
attachments?: string;
/**
* The identifier of the media track the event is related to
*
* @generated from field: optional string mediaTrackId = 3;
*/
mediaTrackId?: string;
/**
* the human readable message of the event
*
* @generated from field: optional string message = 4;
*/
message?: string;
/**
* The EPOCH timestamp the event is generated
*
* @generated from field: optional uint32 timestamp = 5;
*/
timestamp?: number;
constructor(data?: PartialMessage<Samples_ClientSample_CustomObserverEvent>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.CustomObserverEvent";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_CustomObserverEvent;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_CustomObserverEvent;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_CustomObserverEvent;
static equals(a: Samples_ClientSample_CustomObserverEvent | PlainMessage<Samples_ClientSample_CustomObserverEvent> | undefined, b: Samples_ClientSample_CustomObserverEvent | PlainMessage<Samples_ClientSample_CustomObserverEvent> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.DataChannel
*/
export declare class Samples_ClientSample_DataChannel extends Message<Samples_ClientSample_DataChannel> {
/**
* The id of the peer connection the data channel is assigned to
*
* @generated from field: required string peerConnectionId = 1;
*/
peerConnectionId?: string;
/**
* The total number of bytes received on the data channel
*
* @generated from field: optional uint32 bytesReceived = 2;
*/
bytesReceived?: number;
/**
* The total number of bytes sent on the data channel
*
* @generated from field: optional uint32 bytesSent = 3;
*/
bytesSent?: number;
/**
* The id of the data channel assigned by the peer connection when it is opened
*
* @generated from field: optional int32 dataChannelIdentifier = 4;
*/
dataChannelIdentifier?: number;
/**
* The label of the data channel
*
* @generated from field: optional string label = 5;
*/
label?: string;
/**
* The total number of message received on the data channel
*
* @generated from field: optional int32 messageReceived = 6;
*/
messageReceived?: number;
/**
* The total number of message sent on the data channel
*
* @generated from field: optional int32 messageSent = 7;
*/
messageSent?: number;
/**
* The protocol the data channel utilizes
*
* @generated from field: optional string protocol = 8;
*/
protocol?: string;
/**
* The state of the data channel
*
* @generated from field: optional string state = 9;
*/
state?: string;
constructor(data?: PartialMessage<Samples_ClientSample_DataChannel>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.DataChannel";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_DataChannel;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_DataChannel;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_DataChannel;
static equals(a: Samples_ClientSample_DataChannel | PlainMessage<Samples_ClientSample_DataChannel> | undefined, b: Samples_ClientSample_DataChannel | PlainMessage<Samples_ClientSample_DataChannel> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.PeerConnectionTransport
*/
export declare class Samples_ClientSample_PeerConnectionTransport extends Message<Samples_ClientSample_PeerConnectionTransport> {
/**
* The unique identifier of the peer connection
*
* @generated from field: required string peerConnectionId = 1;
*/
peerConnectionId?: string;
/**
* The identifier of the transport the ice candidate pair is negotiated on
*
* @generated from field: required string transportId = 2;
*/
transportId?: string;
/**
* Represents the total amount of bytes received on the corresponded transport
*
* @generated from field: optional uint32 bytesReceived = 3;
*/
bytesReceived?: number;
/**
* Represents the total amount of bytes sent on the corresponded transport
*
* @generated from field: optional uint32 bytesSent = 4;
*/
bytesSent?: number;
/**
* Represents the name of the DTLS cipher used in the corresponded transport
*
* @generated from field: optional string dtlsCipher = 5;
*/
dtlsCipher?: string;
/**
* The role this host plays in DTLS negotiations
*
* @generated from field: optional string dtlsRole = 6;
*/
dtlsRole?: string;
/**
* Represents the current state of DTLS for the peer connection transport layer
*
* @generated from field: optional string dtlsState = 7;
*/
dtlsState?: string;
/**
* Represent the current local username fragment used in message validation procedures for ICE under DTLS Transport
*
* @generated from field: optional string iceLocalUsernameFragment = 8;
*/
iceLocalUsernameFragment?: string;
/**
* Represent the current role of ICE under DTLS Transport
*
* @generated from field: optional string iceRole = 9;
*/
iceRole?: string;
/**
* Represents the current transport state (RTCIceTransportState) of ICE for the peer connection transport layer
*
* @generated from field: optional string iceState = 10;
*/
iceState?: string;
/**
* The label associated with the peer connection
*
* @generated from field: optional string label = 11;
*/
label?: string;
/**
* If DTLS negotiated it gives the id of the local certificate
*
* @generated from field: optional string localCertificateId = 12;
*/
localCertificateId?: string;
/**
* Represents the total number of packets received on the corresponded transport
*
* @generated from field: optional int32 packetsReceived = 13;
*/
packetsReceived?: number;
/**
* Represents the total number of packets sent on the corresponded transport
*
* @generated from field: optional int32 packetsSent = 14;
*/
packetsSent?: number;
/**
* If DTLS negotiated it gives the id of the remote certificate
*
* @generated from field: optional string remoteCertificateId = 15;
*/
remoteCertificateId?: string;
/**
* The total number of candidate pair changes over the peer connection
*
* @generated from field: optional int32 selectedCandidatePairChanges = 16;
*/
selectedCandidatePairChanges?: number;
/**
* The identifier of the candidate pair the transport currently uses
*
* @generated from field: optional string selectedCandidatePairId = 17;
*/
selectedCandidatePairId?: string;
/**
* Represents the name of the SRTP cipher used in the corresponded transport
*
* @generated from field: optional string srtpCipher = 18;
*/
srtpCipher?: string;
/**
* Represents the name of the IANA TLS Supported Groups used in the corresponded transport
*
* @generated from field: optional string tlsGroup = 19;
*/
tlsGroup?: string;
/**
* Represents the version number of the TLS used in the corresponded transport
*
* @generated from field: optional string tlsVersion = 20;
*/
tlsVersion?: string;
constructor(data?: PartialMessage<Samples_ClientSample_PeerConnectionTransport>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.PeerConnectionTransport";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_PeerConnectionTransport;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_PeerConnectionTransport;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_PeerConnectionTransport;
static equals(a: Samples_ClientSample_PeerConnectionTransport | PlainMessage<Samples_ClientSample_PeerConnectionTransport> | undefined, b: Samples_ClientSample_PeerConnectionTransport | PlainMessage<Samples_ClientSample_PeerConnectionTransport> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.IceCandidatePair
*/
export declare class Samples_ClientSample_IceCandidatePair extends Message<Samples_ClientSample_IceCandidatePair> {
/**
* The unique identifier of the peer connection
*
* @generated from field: required string candidatePairId = 1;
*/
candidatePairId?: string;
/**
* The unique identifier of the peer connection
*
* @generated from field: required string peerConnectionId = 2;
*/
peerConnectionId?: string;
/**
* The sum of the underlying cc algorithm provided incoming bitrate for the RTP streams over the corresponded transport
*
* @generated from field: optional double availableIncomingBitrate = 3;
*/
availableIncomingBitrate?: number;
/**
* The sum of the underlying cc algorithm provided outgoing bitrate for the RTP streams over the corresponded transport
*
* @generated from field: optional double availableOutgoingBitrate = 4;
*/
availableOutgoingBitrate?: number;
/**
* Total amount of bytes for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport
*
* @generated from field: optional uint32 bytesDiscardedOnSend = 5;
*/
bytesDiscardedOnSend?: number;
/**
* The total number of bytes received using the last selected candidate pair over the corresponded transport
*
* @generated from field: optional uint32 bytesReceived = 6;
*/
bytesReceived?: number;
/**
* The total number of bytes sent using the last selected candidate pair over the corresponded transport
*
* @generated from field: optional uint32 bytesSent = 7;
*/
bytesSent?: number;
/**
* Represents the total number of consent requests sent on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 consentRequestsSent = 8;
*/
consentRequestsSent?: number;
/**
* Represents the last round trip time measurements in seconds based on STUN connectivity check over the corresponded transport
*
* @generated from field: optional double currentRoundTripTime = 9;
*/
currentRoundTripTime?: number;
/**
* The label associated to the peer connection
*
* @generated from field: optional string label = 10;
*/
label?: string;
/**
* Represents the timestamp at which the last packet was received on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms)
*
* @generated from field: optional uint32 lastPacketReceivedTimestamp = 11;
*/
lastPacketReceivedTimestamp?: number;
/**
* Represents the timestamp at which the last packet was sent on the selected candidate pair, excluding STUN packets over the corresponded transport (UTC Epoch in ms)
*
* @generated from field: optional uint32 lastPacketSentTimestamp = 12;
*/
lastPacketSentTimestamp?: number;
/**
* The unique identifier of the candidate the negotiated pair is selected at local side
*
* @generated from field: optional string localCandidateId = 13;
*/
localCandidateId?: string;
/**
* indicate if the ice candidate pair is nominated or not
*
* @generated from field: optional bool nominated = 14;
*/
nominated?: boolean;
/**
* Total amount of packets for this candidate pair that have been discarded due to socket errors on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 packetsDiscardedOnSend = 15;
*/
packetsDiscardedOnSend?: number;
/**
* The total number of packets received using the last selected candidate pair over the corresponded transport
*
* @generated from field: optional int32 packetsReceived = 16;
*/
packetsReceived?: number;
/**
* The total number of packets sent using the last selected candidate pair over the corresponded transport
*
* @generated from field: optional int32 packetsSent = 17;
*/
packetsSent?: number;
/**
* The unique identifier of the candidate the negotiated pair is selected at remote side
*
* @generated from field: optional string remoteCandidateId = 18;
*/
remoteCandidateId?: string;
/**
* Represents the total number of connectivity check requests received on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 requestsReceived = 19;
*/
requestsReceived?: number;
/**
* Represents the total number of connectivity check requests sent on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 requestsSent = 20;
*/
requestsSent?: number;
/**
* Represents the total number of connectivity check responses received on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 responsesReceived = 21;
*/
responsesReceived?: number;
/**
* Represents the total number of connectivity check responses sent on the selected candidate pair using the corresponded transport
*
* @generated from field: optional int32 responsesSent = 22;
*/
responsesSent?: number;
/**
* The state of ICE Candidate Pairs (RTCStatsIceState) on the corresponded transport
*
* @generated from field: optional string state = 23;
*/
state?: string;
/**
* Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on STUN connectivity check over the corresponded transport
*
* @generated from field: optional double totalRoundTripTime = 24;
*/
totalRoundTripTime?: number;
/**
* The identifier of the transport the ice candidate pair is negotiated on
*
* @generated from field: optional string transportId = 25;
*/
transportId?: string;
constructor(data?: PartialMessage<Samples_ClientSample_IceCandidatePair>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.IceCandidatePair";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_IceCandidatePair;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_IceCandidatePair;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_IceCandidatePair;
static equals(a: Samples_ClientSample_IceCandidatePair | PlainMessage<Samples_ClientSample_IceCandidatePair> | undefined, b: Samples_ClientSample_IceCandidatePair | PlainMessage<Samples_ClientSample_IceCandidatePair> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.MediaSourceStat
*/
export declare class Samples_ClientSample_MediaSourceStat extends Message<Samples_ClientSample_MediaSourceStat> {
/**
* The value is between 0..1 (linear), where 1.0 represents 0 dBov, 0 represents silence, and 0.5 represents approximately 6 dBSPL change in the sound pressure level from 0 dBov.
*
* @generated from field: optional double audioLevel = 1;
*/
audioLevel?: number;
/**
* . The total duration, in seconds, of samples produced by the device that got dropped before reaching the media source
*
* @generated from field: optional double droppedSamplesDuration = 2;
*/
droppedSamplesDuration?: number;
/**
* A counter increases every time a sample is dropped after a non-dropped sample
*
* @generated from field: optional int32 droppedSamplesEvents = 3;
*/
droppedSamplesEvents?: number;
/**
* if echo cancellation is applied on the media source, then this number represents the loss calculation defined in www.itu.int/rec/T-REC-G.168-201504-I/en
*
* @generated from field: optional double echoReturnLoss = 4;
*/
echoReturnLoss?: number;
/**
* www.itu.int/rec/T-REC-G.168-201504-I/en
*
* @generated from field: optional double echoReturnLossEnhancement = 5;
*/
echoReturnLossEnhancement?: number;
/**
* The total number of frames originated from the media source
*
* @generated from field: optional int32 frames = 6;
*/
frames?: number;
/**
* The number of frames origianted from the media source in the last second
*
* @generated from field: optional double framesPerSecond = 7;
*/
framesPerSecond?: number;
/**
* The height, in pixels, of the last frame originating from the media source
*
* @generated from field: optional int32 height = 8;
*/
height?: number;
/**
* The type of the media the Mediasource produces.
*
* @generated from field: optional string kind = 9;
*/
kind?: string;
/**
* Flag indicating if the media source is relayed or not, meaning the local endpoint is not the actual source of the media, but a proxy for that media.
*
* @generated from field: optional bool relayedSource = 10;
*/
relayedSource?: boolean;
/**
* The audio energy of the media source. For calculation see www.w3.org/TR/webrtc-stats/#dom-rtcaudiosourcestats-totalaudioenergy
*
* @generated from field: optional double totalAudioEnergy = 11;
*/
totalAudioEnergy?: number;
/**
* Total delay, in seconds, for each audio sample between the time the sample was emitted by the capture device and the sample reaching the source
*
* @generated from field: optional double totalCaptureDelay = 12;
*/
totalCaptureDelay?: number;
/**
* The total number of captured samples reaching the audio source
*
* @generated from field: optional double totalSamplesCaptured = 13;
*/
totalSamplesCaptured?: number;
/**
* The duration of the audio type media source
*
* @generated from field: optional double totalSamplesDuration = 14;
*/
totalSamplesDuration?: number;
/**
* The unique identifier of the corresponded media track
*
* @generated from field: optional string trackIdentifier = 15;
*/
trackIdentifier?: string;
/**
* The width, in pixels, of the last frame originating from the media source
*
* @generated from field: optional int32 width = 16;
*/
width?: number;
constructor(data?: PartialMessage<Samples_ClientSample_MediaSourceStat>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.MediaSourceStat";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_MediaSourceStat;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaSourceStat;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaSourceStat;
static equals(a: Samples_ClientSample_MediaSourceStat | PlainMessage<Samples_ClientSample_MediaSourceStat> | undefined, b: Samples_ClientSample_MediaSourceStat | PlainMessage<Samples_ClientSample_MediaSourceStat> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.MediaCodecStats
*/
export declare class Samples_ClientSample_MediaCodecStats extends Message<Samples_ClientSample_MediaCodecStats> {
/**
* Audio Only. Represnts the number of chanels an audio media source have. Only interesting if stereo is presented
*
* @generated from field: optional int32 channels = 1;
*/
channels?: number;
/**
* the clock rate used in RTP transport to generate the timestamp for the carried frames
*
* @generated from field: optional int32 clockRate = 2;
*/
clockRate?: number;
/**
* Indicates the role of the codec (encode or decode)
*
* @generated from field: optional string codecType = 3;
*/
codecType?: string;
/**
* The MIME type of the media. eg.: audio/opus.
*
* @generated from field: optional string mimeType = 4;
*/
mimeType?: string;
/**
* Payload type used in RTP encoding / decoding process.
*
* @generated from field: optional string payloadType = 5;
*/
payloadType?: string;
/**
* The SDP line determines the codec
*
* @generated from field: optional string sdpFmtpLine = 6;
*/
sdpFmtpLine?: string;
constructor(data?: PartialMessage<Samples_ClientSample_MediaCodecStats>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.MediaCodecStats";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_MediaCodecStats;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaCodecStats;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_MediaCodecStats;
static equals(a: Samples_ClientSample_MediaCodecStats | PlainMessage<Samples_ClientSample_MediaCodecStats> | undefined, b: Samples_ClientSample_MediaCodecStats | PlainMessage<Samples_ClientSample_MediaCodecStats> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.Certificate
*/
export declare class Samples_ClientSample_Certificate extends Message<Samples_ClientSample_Certificate> {
/**
* The DER encoded base-64 representation of the certificate.
*
* @generated from field: optional string base64Certificate = 1;
*/
base64Certificate?: string;
/**
* The fingerprint of the certificate.
*
* @generated from field: optional string fingerprint = 2;
*/
fingerprint?: string;
/**
* The hash function used to generate the fingerprint.
*
* @generated from field: optional string fingerprintAlgorithm = 3;
*/
fingerprintAlgorithm?: string;
/**
* The id of the next certificate in the certificate chain
*
* @generated from field: optional string issuerCertificateId = 4;
*/
issuerCertificateId?: string;
constructor(data?: PartialMessage<Samples_ClientSample_Certificate>);
static readonly runtime: any;
static readonly typeName = "org.observertc.schemas.protobuf.Samples.ClientSample.Certificate";
static readonly fields: FieldList;
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Samples_ClientSample_Certificate;
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Samples_ClientSample_Certificate;
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Samples_ClientSample_Certificate;
static equals(a: Samples_ClientSample_Certificate | PlainMessage<Samples_ClientSample_Certificate> | undefined, b: Samples_ClientSample_Certificate | PlainMessage<Samples_ClientSample_Certificate> | undefined): boolean;
}
/**
* @generated from message org.observertc.schemas.protobuf.Samples.ClientSample.InboundAudioTrack
*/
export declare class Samples_ClientSample_InboundAudioTrack extends Message<Samples_ClientSample_InboundAudioTrack> {
/**
* The RTP SSRC field
*
* @generated from field: required uint32 ssrc = 1;
*/
ssrc?: number;
/**
* The current audio level
*
* @generated from field: optional int32 audioLevel = 2;
*/
audioLevel?: number;
/**
* Total number of bytes received over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired.
*
* @generated from field: optional uint32 bytesReceived = 3;
*/
bytesReceived?: number;
/**
* Total number of payload bytes sent at the remote endpoint to this endpoint on this synchronization source
*
* @generated from field: optional uint32 bytesSent = 4;
*/
bytesSent?: number;
/**
* The total number of samples decoded by the media decoder from the corresponded RTP stream
*
* @generated from field: optional int32 concealedSamples = 5;
*/
concealedSamples?: number;
/**
* The total number of concealed event emitted to the media codec by the corresponded jitterbuffer
*
* @generated from field: optional int32 concealmentEvents = 6;
*/
concealmentEvents?: number;
/**
* Indicate the name of the decoder implementation library
*
* @generated from field: optional string decoderImplementation = 7;
*/
decoderImplementation?: string;
/**
* The estimated playout time of the corresponded synchronization source
*
* @generated from field: optional uint32 estimatedPlayoutTimestamp = 8;
*/
estimatedPlayoutTimestamp?: number;
/**
* Total number of FEC packets discarded over the corresponding synchronization source (ssrc) due to 1) late arrive; 2) the target RTP packet has already been repaired.
*
* @generated from field: optional int32 fecPacketsDiscarded = 9;
*/
fecPacketsDiscarded?: number;
/**
* Total number of FEC packets received over the corresponding synchronization source (ssrc)
*
* @generated from field: optional int32 fecPacketsReceived = 10;
*/
fecPacketsReceived?: number;
/**
* Total number of RTP header and padding bytes received over the corresponding synchronization source (ssrc)
*
* @generated from field: optional uint32 headerBytesReceived = 11;
*/
headerBytesReceived?: number;
/**
* The total number of samples inserted to decelarete the audio playout (happens when the jitterbuffer detects a shrinking buffer and need to increase the jitter buffer delay)
*
* @generated from field: optional int32 insertedSamplesForDeceleration = 12;
*/
insertedSamplesForDeceleration?: number;
/**
* The corresponded synchronization source reported jitter