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

Bitmovin JS/TS API SDK

import BitmovinResource from './BitmovinResource';
import StreamKeyStatus from './StreamKeyStatus';
import StreamKeyType from './StreamKeyType';
/**
 * @export
 * @class StreamKey
 */
export declare class StreamKey extends BitmovinResource {
    /**
     * Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. **Important:** This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised.
     * @type {string}
     * @memberof StreamKey
     */
    value?: string;
    /**
     * Status of the stream key
     * @type {StreamKeyStatus}
     * @memberof StreamKey
     */
    status?: StreamKeyStatus;
    /**
     * Type of the stream key
     * @type {StreamKeyType}
     * @memberof StreamKey
     */
    type?: StreamKeyType;
    /**
     * ID of the encoding that is assigned to this stream key. Not set if status is UNASSIGNED
     * @type {string}
     * @memberof StreamKey
     */
    assignedEncodingId?: string;
    /**
     * ID of the ingest point that is assigned to this stream key. Not set if status is UNASSIGNED
     * @type {string}
     * @memberof StreamKey
     */
    assignedIngestPointId?: string;
    constructor(obj?: Partial<StreamKey>);
}
export default StreamKey;