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).
Updates an event for HLS/HDS – Live Streaming.
It may take up to 10 minutes before changes to an event take effect.
A request to update an event is described below.
HTTP Method | Request URI |
---|---|
PUT |
https://api.edgecast.com/v2/mcc/customers/AccountNumber/httpstreaming/livehlshds/EventID |
Define the following variables 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 |
---|---|
Required |
|
Required |
Replace this variable with the ID associated with the event that will be updated. Use the Get All Events endpoint to retrieve a list of events and IDs. |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
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:
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. |
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
|
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request does not contain a response parameter.
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is provided below.
PUT https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/livehlshds/15 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Content-Type: application/json
Host:api.edgecast.com
Content-Length: 118
{
"EventName" : "event1",
"Expiration" : "2024-05-05",
"InstanceName" : "default",
"KeyFrameInterval" : 3
}
A sample JSON response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
A sample XML request is provided below.
PUT https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/livehlshds/15 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Content-Type: application/xml
Host:api.edgecast.com
Content-Length: 266
<HttpStreaming.HlsHdsInputAPI xmlns="http://www.whitecdn.com/schemas/apiservices/">
<EventName>event1</EventName>
<Expiration>2024-05-05</Expiration>
<InstanceName>default</InstanceName>
<KeyFrameInterval>3</KeyFrameInterval>
</HttpStreaming.HlsHdsInputAPI>
A sample XML response is provided below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT