Class LiveApi
Inheritance
System.Object
LiveApi
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Encoding.Encodings.Live
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class LiveApi
Constructors
LiveApi(IBitmovinApiClientFactory)
Declaration
public LiveApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type | Name | Description |
---|---|---|
IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of LiveApi
Declaration
public static BitmovinApiBuilder<LiveApi> Builder { get; }
Property Value
Type | Description |
---|---|
BitmovinApiBuilder<LiveApi> |
InsertableContent
Declaration
public InsertableContentApi InsertableContent { get; }
Property Value
Type | Description |
---|---|
InsertableContentApi |
Scte35Cue
Declaration
public Scte35CueApi Scte35Cue { get; }
Property Value
Type | Description |
---|---|
Scte35CueApi |
Methods
GetAsync(String)
Live Encoding Details
Declaration
public Task<LiveEncoding> GetAsync(string encodingId)
Parameters
Type | Name | Description |
---|---|---|
System.String | encodingId | Id of the encoding. (required) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LiveEncoding> |
GetStartRequestAsync(String)
Live Encoding Start Details
Declaration
public Task<StartLiveEncodingRequest> GetStartRequestAsync(string encodingId)
Parameters
Type | Name | Description |
---|---|---|
System.String | encodingId | Id of the encoding (required) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<StartLiveEncodingRequest> |
RestartAsync(String)
Re-Start Live Encoding
Declaration
public Task<BitmovinResponse> RestartAsync(string encodingId)
Parameters
Type | Name | Description |
---|---|---|
System.String | encodingId | Id of the encoding (required) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<BitmovinResponse> |
StartAsync(String, StartLiveEncodingRequest)
Start Live Encoding
Declaration
public Task<BitmovinResponse> StartAsync(string encodingId, StartLiveEncodingRequest startLiveEncodingRequest)
Parameters
Type | Name | Description |
---|---|---|
System.String | encodingId | Id of the encoding (required) |
StartLiveEncodingRequest | startLiveEncodingRequest | Live Encoding startup options |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<BitmovinResponse> |
StopAsync(String)
Stop Live Encoding
Declaration
public Task<BitmovinResponse> StopAsync(string encodingId)
Parameters
Type | Name | Description |
---|---|---|
System.String | encodingId | Id of the encoding (required) |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<BitmovinResponse> |