// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../resource'; import * as Core from '../../../core'; import { SinglePage } from '../../../pagination'; export 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 { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/stream/live_inputs/${liveInputIdentifier}/outputs`, { body, ...options, }) as Core.APIPromise<{ result: Output }> )._thenUnwrap((obj) => obj.result); } /** * Updates the state of an output. */ update( liveInputIdentifier: string, outputIdentifier: string, params: OutputUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.put( `/accounts/${account_id}/stream/live_inputs/${liveInputIdentifier}/outputs/${outputIdentifier}`, { body, ...options }, ) as Core.APIPromise<{ result: Output }> )._thenUnwrap((obj) => obj.result); } /** * Retrieves all outputs associated with a specified live input. */ list( liveInputIdentifier: string, params: OutputListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id } = params; return this._client.getAPIList( `/accounts/${account_id}/stream/live_inputs/${liveInputIdentifier}/outputs`, OutputsSinglePage, options, ); } /** * Deletes an output and removes it from the associated live input. */ delete( liveInputIdentifier: string, outputIdentifier: string, params: OutputDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return this._client.delete( `/accounts/${account_id}/stream/live_inputs/${liveInputIdentifier}/outputs/${outputIdentifier}`, { ...options, headers: { Accept: '*/*', ...options?.headers } }, ); } } export class OutputsSinglePage extends SinglePage {} export interface Output { /** * 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; } Outputs.OutputsSinglePage = OutputsSinglePage; export declare namespace Outputs { export { type Output as Output, OutputsSinglePage as OutputsSinglePage, type OutputCreateParams as OutputCreateParams, type OutputUpdateParams as OutputUpdateParams, type OutputListParams as OutputListParams, type OutputDeleteParams as OutputDeleteParams, }; }