Class SubtitlesApi

Hierarchy

BaseAPI
BaseAPI
BaseAPI
- SubtitlesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SubtitlesApi(configuration: Configuration): SubtitlesApi

Overrides BaseAPI.constructor
- Defined in encoding/configurations/subtitles/SubtitlesApi.ts:17
Parameters
- configuration: Configuration
Returns SubtitlesApi

Properties

dvbSubtitle

dvbSubtitle: DvbSubtitleApi

dvbTeletext

dvbTeletext: DvbTeletextApi

imsc

Protected restClient

restClient: RestClient

webvtt

webvtt: WebvttApi

Methods

create

create(manifestId: string, subtitlesMediaInfo: SubtitlesMediaInfo): Promise<SubtitlesMediaInfo>

- Defined in encoding/manifests/hls/media/subtitles/SubtitlesApi.ts:28
Parameters
- manifestId: string
- Optional subtitlesMediaInfo: SubtitlesMediaInfo
Returns Promise<SubtitlesMediaInfo>

delete

delete(manifestId: string, mediaId: string): Promise<BitmovinResponse>

- Defined in encoding/manifests/hls/media/subtitles/SubtitlesApi.ts:44
Parameters
- manifestId: string
- mediaId: string
Returns Promise<BitmovinResponse>

get

get(manifestId: string, mediaId: string): Promise<SubtitlesMediaInfo>

- Defined in encoding/manifests/hls/media/subtitles/SubtitlesApi.ts:61
Parameters
- manifestId: string
- mediaId: string
Returns Promise<SubtitlesMediaInfo>

list

list(manifestId: string, queryParameters: SubtitlesMediaInfoListQueryParams | function): Promise<PaginationResponse<SubtitlesMediaInfo>>

- Defined in encoding/manifests/hls/media/subtitles/SubtitlesApi.ts:78
Parameters
- manifestId: string
- Optional queryParameters: SubtitlesMediaInfoListQueryParams | function
Returns Promise<PaginationResponse<SubtitlesMediaInfo>>

Generated using TypeDoc