com.bitmovin.api.sdk.encoding.encodings.live

Class LiveApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.live.LiveApi

public class LiveApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
InsertableContentApi	insertableContent
Scte35CueApi	scte35Cue

Constructor Summary

Constructors

Constructor and Description
LiveApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<LiveApi>	builder() Fluent builder for creating an instance of LiveApi
LiveEncoding	get(String encodingId) Live Encoding Details
StartLiveEncodingRequest	getStartRequest(String encodingId) Live Encoding Start Details
BitmovinResponse	restart(String encodingId) Re-Start Live Encoding
BitmovinResponse	start(String encodingId, StartLiveEncodingRequest startLiveEncodingRequest) Start Live Encoding
BitmovinResponse	stop(String encodingId) Stop Live Encoding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

insertableContent

public final InsertableContentApi insertableContent

scte35Cue

public final Scte35CueApi scte35Cue

Constructor Detail

LiveApi

public LiveApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<LiveApi> builder()

Fluent builder for creating an instance of LiveApi

get

public LiveEncoding get(String encodingId)
                 throws BitmovinException

Live Encoding Details

Parameters:

encodingId - Id of the encoding. (required)

Returns:

LiveEncoding

Throws:

BitmovinException - if fails to make API call

getStartRequest

public StartLiveEncodingRequest getStartRequest(String encodingId)
                                         throws BitmovinException

Live Encoding Start Details

Parameters:

encodingId - Id of the encoding (required)

Returns:

StartLiveEncodingRequest

Throws:

BitmovinException - if fails to make API call

restart

public BitmovinResponse restart(String encodingId)
                         throws BitmovinException

Re-Start Live Encoding

Parameters:

encodingId - Id of the encoding (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

start

public BitmovinResponse start(String encodingId,
                              StartLiveEncodingRequest startLiveEncodingRequest)
                       throws BitmovinException

Start Live Encoding

Parameters:

encodingId - Id of the encoding (required)

startLiveEncodingRequest - Live Encoding startup options (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

stop

public BitmovinResponse stop(String encodingId)
                      throws BitmovinException

Stop Live Encoding

Parameters:

encodingId - Id of the encoding (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call