Interface ListMediaAssetsQueryParams

The allowable parameters for listing and filtering media assets.

interface ListMediaAssetsQueryParams {
    desc?: boolean;
    limit?: number;
    name?: string;
    page?: number;
    priority?: number;
    simulcastId?: string;
    sort?: ListMediaAssetSortBy;
    sourceId?: string;
    status?: string[];
    streamName?: string;
    tokenId?: number;
    type?: string[];
}

Properties

desc? limit? name? page? priority? simulcastId? sort? sourceId? status? streamName? tokenId? type?

Properties

Optional desc

desc?: boolean

Optional, defaults to false, sort descending boolean.

Optional limit

limit?: number

Optional, integer, 1 to 100, defaults to 25.

Optional name

name?: string

Optional. Filter by media asset name.

Optional page

page?: number

Optional, integer, 1 to 2147483647, defaults to 1

Optional priority

priority?: number

Optional, int32, Priority of the clip request to filter by.

Optional simulcastId

simulcastId?: string

Optional, with behavior for empty string, Simulcast ID of the stream to filter by.

Optional sort

sort?: ListMediaAssetSortBy

Defaults to "startTime".

Optional sourceId

sourceId?: string

Optional, Source ID of the stream to filter by.

Optional status

status?: string[]

Defaults to ["Processing", "Complete"] unless specified.

Optional streamName

streamName?: string

Optional, Name of the stream to filter by.

Optional tokenId

tokenId?: number

Optional, Token ID of the stream to filter by.

Optional type

type?: string[]

Defaults to ["Clip", "Recording"] unless specified.

Settings

Member Visibility

Theme

On This Page

desclimitnamepageprioritysimulcastIdsortsourceIdstatusstreamNametokenIdtype