Add Event (HLS/HDS) - Discontinued

The Flash Media StreamingThis service was discontinued on 5/31/2017. The Flash Media Streaming platform streamed live and on-demand content via a Flash media player over a RTMP-based protocol., HLSAllows the creation of a customized report data., and HDS services were discontinued on May 31, 2017. The information in this article is solely provided as a reference for the migration of automation scripts to a different streaming technology (e.g., Dynamic Cloud Packaging).

Adds an event for HLS/HDS – Live Streaming.

It may take up to 10 minutes before the creation of an event takes effect.

Request

A request to add an event is described below.

HTTP Method	Request URI
POST	https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/livehlshds

Define the following variable when submitting the above request.

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Pass the following request body parameters:

Name	Data Type	Description
Encrypted	Integer	Optional. Determines whether HLS streams will undergo AES-128 encryption. Valid values are: 0: Disables encryption. 1: Enables encryption. Default Value: Disabled
EventName Required	String	Defines a description for the type of stream that will be associated with this event.
Expiration Required	String	Defines the event's expiration date/time. Format: YYYY-MM-DD Learn more.
InstanceName Required	String	Defines the name of the application instance. An application instance is typically used to identify your encoder.
KeyFrameInterval Required	Integer	Defines the time interval, in seconds, between key frames in the encoded video. This setting must match the key frame frequency configuration defined in the encoder that will leverage this event. Recommended values for this setting are 3, 4, or 5 seconds.
DvrDuration	Integer	Optional. Defines the number of minutes for DVR playback. Valid values range from 5 to 180. Default Value: Disabled A live stream must have a minimum buffer window of 60 seconds. This window exists regardless of whether DVR has been enabled on a stream.
SegmentSize	String	Optional. Defines segment size in seconds. Valid values range from 1 to 20. Default Value: 10 seconds

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameter:

Name	Data Type	Description
Id	Integer	Indicates the unique ID assigned to the new event.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is provided below.

{
	"EventName" : "event1",
	"Expiration" : "2016-10-31",
	"InstanceName" : "default",
	"KeyFrameInterval" : 3
}

A sample JSON response is provided below.

{
	"Id" : 123
}

Sample Request and Response (XML)

A sample XML request is provided below.

<HttpStreaming.HlsHdsInputAPI xmlns="http://www.whitecdn.com/schemas/apiservices/">
	<EventName>event1</EventName>
	<Expiration>2016-10-31</Expiration>
	<InstanceName>default</InstanceName>
	<KeyFrameInterval>3</KeyFrameInterval>
</HttpStreaming.HlsHdsInputAPI>

A sample XML response is provided below.

<HttpStreaming.HlsHdsIdAPI xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>123</Id>
</HttpStreaming.HlsHdsIdAPI>