cloudflare
Version:
The official TypeScript library for the Cloudflare API
105 lines • 4.04 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as OutputsAPI from 'cloudflare/resources/stream/live-inputs/outputs';
import { SinglePage } from 'cloudflare/pagination';
export declare class Outputs extends APIResource {
/**
* Creates a new output that can be used to simulcast or restream live video to
* other RTMP or SRT destinations. Outputs are always linked to a specific live
* input — one live input can have many outputs.
*/
create(liveInputIdentifier: string, params: OutputCreateParams, options?: Core.RequestOptions): Core.APIPromise<StreamOutput>;
/**
* Updates the state of an output.
*/
update(liveInputIdentifier: string, outputIdentifier: string, params: OutputUpdateParams, options?: Core.RequestOptions): Core.APIPromise<StreamOutput>;
/**
* Retrieves all outputs associated with a specified live input.
*/
list(liveInputIdentifier: string, params: OutputListParams, options?: Core.RequestOptions): Core.PagePromise<StreamOutputsSinglePage, StreamOutput>;
/**
* Deletes an output and removes it from the associated live input.
*/
delete(liveInputIdentifier: string, outputIdentifier: string, params: OutputDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void>;
}
export declare class StreamOutputsSinglePage extends SinglePage<StreamOutput> {
}
export interface StreamOutput {
/**
* When enabled, live video streamed to the associated live input will be sent to
* the output URL. When disabled, live video will not be sent to the output URL,
* even when streaming to the associated live input. Use this to control precisely
* when you start and stop simulcasting to specific destinations like YouTube and
* Twitch.
*/
enabled?: boolean;
/**
* The streamKey used to authenticate against an output's target.
*/
streamKey?: string;
/**
* A unique identifier for the output.
*/
uid?: string;
/**
* The URL an output uses to restream.
*/
url?: string;
}
export interface OutputCreateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param: The streamKey used to authenticate against an output's target.
*/
streamKey: string;
/**
* Body param: The URL an output uses to restream.
*/
url: string;
/**
* Body param: When enabled, live video streamed to the associated live input will
* be sent to the output URL. When disabled, live video will not be sent to the
* output URL, even when streaming to the associated live input. Use this to
* control precisely when you start and stop simulcasting to specific destinations
* like YouTube and Twitch.
*/
enabled?: boolean;
}
export interface OutputUpdateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param: When enabled, live video streamed to the associated live input will
* be sent to the output URL. When disabled, live video will not be sent to the
* output URL, even when streaming to the associated live input. Use this to
* control precisely when you start and stop simulcasting to specific destinations
* like YouTube and Twitch.
*/
enabled: boolean;
}
export interface OutputListParams {
/**
* Identifier
*/
account_id: string;
}
export interface OutputDeleteParams {
/**
* Identifier
*/
account_id: string;
}
export declare namespace Outputs {
export import StreamOutput = OutputsAPI.StreamOutput;
export import StreamOutputsSinglePage = OutputsAPI.StreamOutputsSinglePage;
export import OutputCreateParams = OutputsAPI.OutputCreateParams;
export import OutputUpdateParams = OutputsAPI.OutputUpdateParams;
export import OutputListParams = OutputsAPI.OutputListParams;
export import OutputDeleteParams = OutputsAPI.OutputDeleteParams;
}
//# sourceMappingURL=outputs.d.ts.map