public class EncodingsApi extends Object
Modifier and Type | Field and Description |
---|---|
CaptionsApi |
captions |
CustomdataApi |
customdata |
InputStreamsApi |
inputStreams |
KeyframesApi |
keyframes |
LiveApi |
live |
MuxingsApi |
muxings |
OutputPathsApi |
outputPaths |
SidecarsApi |
sidecars |
StreamsApi |
streams |
TransferRetriesApi |
transferRetries |
Constructor and Description |
---|
EncodingsApi(BitmovinApiClientFactory clientFactory) |
Modifier and Type | Method and Description |
---|---|
static BitmovinApiBuilder<EncodingsApi> |
builder()
Fluent builder for creating an instance of EncodingsApi
|
Encoding |
create(Encoding encoding)
Create Encoding
|
BitmovinResponse |
delete(String encodingId)
Delete Encoding
|
Encoding |
get(String encodingId)
Encoding Details
|
StartEncodingRequest |
getStartRequest(String encodingId)
Encoding Start Details
|
PaginationResponse<Encoding> |
list()
List all Encodings
|
PaginationResponse<Encoding> |
list(EncodingListQueryParams queryParams)
List all Encodings
|
BitmovinResponse |
reprioritize(String encodingId,
ReprioritizeEncodingRequest reprioritizeEncodingRequest)
Reprioritize Encoding
|
BitmovinResponse |
reschedule(String encodingId,
RescheduleEncodingRequest rescheduleEncodingRequest)
Reschedule Encoding
|
BitmovinResponse |
start(String encodingId)
Start Encoding
|
BitmovinResponse |
start(String encodingId,
StartEncodingRequest startEncodingRequest)
Start Encoding
|
Task |
status(String encodingId)
Encoding Status
|
BitmovinResponse |
stop(String encodingId)
Stop Encoding
|
public final LiveApi live
public final CustomdataApi customdata
public final StreamsApi streams
public final InputStreamsApi inputStreams
public final MuxingsApi muxings
public final TransferRetriesApi transferRetries
public final OutputPathsApi outputPaths
public final CaptionsApi captions
public final SidecarsApi sidecars
public final KeyframesApi keyframes
public EncodingsApi(BitmovinApiClientFactory clientFactory)
public static BitmovinApiBuilder<EncodingsApi> builder()
public Encoding create(Encoding encoding) throws BitmovinException
encoding
- The Encoding to be created (required)BitmovinException
- if fails to make API callpublic BitmovinResponse delete(String encodingId) throws BitmovinException
encodingId
- Id of the encoding. (required)BitmovinException
- if fails to make API callpublic Encoding get(String encodingId) throws BitmovinException
encodingId
- Id of the encoding. (required)BitmovinException
- if fails to make API callpublic StartEncodingRequest getStartRequest(String encodingId) throws BitmovinException
encodingId
- Id of the encoding (required)BitmovinException
- if fails to make API callpublic PaginationResponse<Encoding> list() throws BitmovinException
BitmovinException
- if fails to make API callpublic PaginationResponse<Encoding> list(EncodingListQueryParams queryParams) throws BitmovinException
queryParams
- The query parameters for sorting, filtering and paging options (optional)BitmovinException
- if fails to make API callpublic BitmovinResponse reprioritize(String encodingId, ReprioritizeEncodingRequest reprioritizeEncodingRequest) throws BitmovinException
encodingId
- Id of the encoding. (required)reprioritizeEncodingRequest
- Reprioritization options (required)BitmovinException
- if fails to make API callpublic BitmovinResponse reschedule(String encodingId, RescheduleEncodingRequest rescheduleEncodingRequest) throws BitmovinException
encodingId
- Id of the encoding. (required)rescheduleEncodingRequest
- Rescheduling options (required)BitmovinException
- if fails to make API callpublic BitmovinResponse start(String encodingId) throws BitmovinException
encodingId
- Id of the encoding (required)BitmovinException
- if fails to make API callpublic BitmovinResponse start(String encodingId, StartEncodingRequest startEncodingRequest) throws BitmovinException
encodingId
- Id of the encoding (required)startEncodingRequest
- Encoding Startup Options (optional)BitmovinException
- if fails to make API callpublic Task status(String encodingId) throws BitmovinException
encodingId
- Id of the encoding (required)BitmovinException
- if fails to make API callpublic BitmovinResponse stop(String encodingId) throws BitmovinException
encodingId
- Id of the encoding (required)BitmovinException
- if fails to make API callCopyright © 2022. All rights reserved.