@bitmovin/api-sdk/dist/models/LiveEncodingHeartbeatIngestStream.d.ts

Bitmovin JS/TS API SDK

/**
 * Details about an individual stream within the live ingest.
 * @export
 * @class LiveEncodingHeartbeatIngestStream
 */
export declare class LiveEncodingHeartbeatIngestStream {
    /**
     * Unique identifier of the stream.
     * @type {string}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    streamId?: string;
    /**
     * Media type for the stream (e.g., \"video\" or \"audio\").
     * @type {string}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    mediaType?: string;
    /**
     * Width of the video stream in pixels.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    width?: number;
    /**
     * Height of the video stream in pixels.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    height?: number;
    /**
     * Frame rate of the video stream.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    rate?: number;
    /**
     * Codec of the stream.
     * @type {string}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    codec?: string;
    /**
     * Aspect ratio of the video.
     * @type {string}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    aspectRatio?: string;
    /**
     * Container format's bitrate of the stream, in bits per second.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    bitrate?: number;
    /**
     * Average number of samples/frames read per second.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    samplesReadPerSecondAvg?: number;
    /**
     * Incoming bitrate measured in bits per second.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    incomingBitrate?: number;
    /**
     * Largest encountered key-frame interval in milliseconds.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    keyFrameIntervalMax?: number;
    /**
     * Average key-frame interval in milliseconds.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    keyFrameIntervalAvg?: number;
    /**
     * Largest key-frame interval observed over the last minute, in milliseconds. Absent until the rolling window has at least one sample.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    keyFrameIntervalMaxLastMinute?: number;
    /**
     * Average key-frame interval over the last minute, in milliseconds. Absent until the rolling window has at least one sample.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    keyFrameIntervalAvgLastMinute?: number;
    /**
     * Last presentation timestamp (PTS) of the stream.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    lastTimestamp?: number;
    /**
     * Timescale of lastTimestamp
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    lastTimestampTimescale?: number;
    /**
     * Number of audio channels.
     * @type {number}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    numberOfAudioChannels?: number;
    /**
     * Format of the audio channel.
     * @type {string}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    audioChannelFormat?: string;
    /**
     * lastArrivalTime timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
     * @type {Date}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    lastArrivalTime?: Date;
    /**
     * Indicates whether this particular stream is healthy.
     * @type {boolean}
     * @memberof LiveEncodingHeartbeatIngestStream
     */
    healthy?: boolean;
    constructor(obj?: Partial<LiveEncodingHeartbeatIngestStream>);
}
export default LiveEncodingHeartbeatIngestStream;