@dolbyio/dolbyio-rest-apis-client - v6.2.0
    Preparing search index...

    Interface StreamDetails

    Represents a stream details.

    interface StreamDetails {
        clusterId: string;
        clusters: string[];
        endTime: string;
        feeds: {
            active: boolean;
            client: {
                city: string;
                continent: string;
                coordinates: number[];
                country: string;
                ip: string;
                sub: string[];
            };
            clusterId: string;
            endTime?: string;
            feedId: string;
            feedStats: FeedStats[];
            frameRate: number;
            isRecordingAllowed: boolean;
            isRedundant?: boolean;
            packetLoss: number;
            priority?: number;
            restreams: Restream[];
            serverId: string;
            simulcastId: string;
            sourceId: string;
            startTime: string;
            streamId: string;
            tokenId: number;
            trackDetails: {
                encodingDetails: {
                    bFrameRate: number;
                    encodingId: string;
                    encodingStats: {
                        audioCodec: number;
                        bFrames?: number;
                        bitRate: { audioBitrate: number; videoBitrate: number };
                        bufferTime?: number;
                        frames?: number;
                        resolution: { height: number; width: number };
                        rtt?: number;
                        timestamp: string;
                        videoCodec: number;
                    }[];
                    iFrameRate: number;
                    pFrameRate: number;
                }[];
                trackId: string;
            }[];
            type: string;
        }[];
        hasRedundant: boolean;
        isRecordingAllowed: boolean;
        live: boolean;
        multisource: boolean;
        restreaming: boolean;
        secureStream: boolean;
        startTime: string;
        streamId: string;
        streamName: string;
        viewerCount: number;
    }
    Index

    Properties

    clusterId: string

    Identifier of the cluster.

    clusters: string[]

    List of clusters.

    endTime: string

    Stream publishing end time.

    feeds: {
        active: boolean;
        client: {
            city: string;
            continent: string;
            coordinates: number[];
            country: string;
            ip: string;
            sub: string[];
        };
        clusterId: string;
        endTime?: string;
        feedId: string;
        feedStats: FeedStats[];
        frameRate: number;
        isRecordingAllowed: boolean;
        isRedundant?: boolean;
        packetLoss: number;
        priority?: number;
        restreams: Restream[];
        serverId: string;
        simulcastId: string;
        sourceId: string;
        startTime: string;
        streamId: string;
        tokenId: number;
        trackDetails: {
            encodingDetails: {
                bFrameRate: number;
                encodingId: string;
                encodingStats: {
                    audioCodec: number;
                    bFrames?: number;
                    bitRate: { audioBitrate: number; videoBitrate: number };
                    bufferTime?: number;
                    frames?: number;
                    resolution: { height: number; width: number };
                    rtt?: number;
                    timestamp: string;
                    videoCodec: number;
                }[];
                iFrameRate: number;
                pFrameRate: number;
            }[];
            trackId: string;
        }[];
        type: string;
    }[]

    Feeds.

    Type Declaration

    • active: boolean

      Is the feed active.

    • client: {
          city: string;
          continent: string;
          coordinates: number[];
          country: string;
          ip: string;
          sub: string[];
      }

      Client.

      • city: string

        City.

      • continent: string

        Continent.

      • coordinates: number[]

        coordinates.

      • country: string

        Country.

      • ip: string

        IP Address.

      • sub: string[]

        Sub.

    • clusterId: string

      Identifier of the cluster.

    • OptionalendTime?: string

      Stream publishing end time.

    • feedId: string

      Identifier of the feed.

    • feedStats: FeedStats[]

      Feed statistics.

    • frameRate: number

      Framerate.

    • isRecordingAllowed: boolean

      Is recording allowed for this stream.

    • OptionalisRedundant?: boolean

      Is the feed redundant.

    • packetLoss: number

      Packet loss percentage over last five minutes.

    • Optionalpriority?: number

      Feed priority.

    • restreams: Restream[]

      Restream information.

    • serverId: string

      Server ID.

    • simulcastId: string

      Simulcast ID.

    • sourceId: string

      Identifier of the source.

    • startTime: string

      Stream publishing start time.

    • streamId: string

      Identifier of the stream.

    • tokenId: number

      Identifier of the token.

    • trackDetails: {
          encodingDetails: {
              bFrameRate: number;
              encodingId: string;
              encodingStats: {
                  audioCodec: number;
                  bFrames?: number;
                  bitRate: { audioBitrate: number; videoBitrate: number };
                  bufferTime?: number;
                  frames?: number;
                  resolution: { height: number; width: number };
                  rtt?: number;
                  timestamp: string;
                  videoCodec: number;
              }[];
              iFrameRate: number;
              pFrameRate: number;
          }[];
          trackId: string;
      }[]

      Details for all tracks.

    • type: string

      Feed type.

    hasRedundant: boolean

    Has redundant stream.

    isRecordingAllowed: boolean

    Is recording allowed for this stream.

    live: boolean

    Is the stream live.

    multisource: boolean

    Is multisource enabled.

    restreaming: boolean

    Restreaming enabled.

    secureStream: boolean

    Secure stream.

    startTime: string

    Stream publishing start time.

    streamId: string

    Identifier of the stream.

    streamName: string

    Name of the stream.

    viewerCount: number

    Viewer count.