Class TranscodingsResource

Transcoding API — post-process finished recordings and HLS streams into downloadable files.

Start a job with merge/hlsToMp4/meetingRecordingMerge, then track it via list/get or stop it with cancel.

Index

Constructors

Methods

cancel get hlsToMp4 list meetingRecordingMerge merge

Constructors

constructor

new TranscodingsResource(http: HttpClient): TranscodingsResource
Parameters
- http: HttpClient
Returns TranscodingsResource

Methods

cancel

cancel(id: string): Promise<Transcoding>
Cancel a pending/processing transcoding job.
Parameters
- id: string
Returns Promise<Transcoding>

get

get(id: string): Promise<Transcoding>
Fetch a transcoding job by id.
Parameters
- id: string
Returns Promise<Transcoding>

hlsToMp4

hlsToMp4(options: HlsToMp4Options): Promise<Transcoding>
Convert a finished HLS stream to MP4 in your configured storage.
Parameters
- options: HlsToMp4Options
Returns Promise<Transcoding>

list

list(params?: ListTranscodingsParams): Promise<Page<Transcoding>>
List transcoding jobs (paginated, async-iterable).
Parameters
- params: ListTranscodingsParams = {}
Returns Promise<Page<Transcoding>>

meetingRecordingMerge

meetingRecordingMerge(
options: MeetingRecordingMergeOptions,
): Promise<Transcoding>
Concatenate multiple room recordings end-to-end (chronologically).
Parameters
- options: MeetingRecordingMergeOptions
Returns Promise<Transcoding>

merge

merge(options: MergeTranscodingOptions): Promise<Transcoding>
Composite-merge multiple individual recordings into one MP4.
Parameters
- options: MergeTranscodingOptions
Returns Promise<Transcoding>