Show search and navigation.

 

Get 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).

Retrieves a HLS/HDS – Live Streaming event.

Request

A request to retrieve an event is described below.

HTTP Method Request URI

GET

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

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.

EventID

Required

Replace this variable with the ID associated with the event that will be retrieved.

Use the Get All Events endpoint to retrieve a list of events and IDs.

Request Headers

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

Request Body

Request body parameters are not required by this endpoint.

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 parameters:

Name Data Type Description

Id

Integer

Indicates the unique system-defined ID corresponding to the event.

EventName

String

Provides a description for the type of stream that will be associated with an event.

InstanceName

String

Indicates the name of the application instance.

KeyFrameInterval

Integer

Indicates the time interval, in seconds, between key frames in the encoded media.

Expiration

String

Indicates the event's expiration date.

PublishingPoints

Array

This parameter contains a list of publishing point URLs associated with this event and their corresponding region.

Region

Integer

PublishingPoints array

Indicates the region associated with a publishing point URL.

Url

String

PublishingPoints array

Indicates a publishing point URL.

HLSPlaybackUrl

String

Indicates the player URL through which media playback can be performed for HTTP Live Streaming.

HDSPlaybackUrl

String

Indicates the player URL through which media playback can be performed for HTTP Dynamic Streaming.

Encrypted

Boolean

Indicates whether HLS streams will undergo AES-128 encryption.

DvrDuration

Integer

Indicates the number of minutes for DVR playback.

Valid values range from 5 to 180.

If this setting is set to null, then the DVR feature has been disabled.

SegmentSize

String

Indicates segment size in seconds.

Valid values range from 1 to 20.

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.

GET https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/livehlshds/15 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host:api.edgecast.com

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

Content-Length: 1351

{
	"Id" : 137,
	"EventName" : "event1",
	"InstanceName" : "default",
	"KeyFrameInterval" : 3,
	"Expiration" : "2024-03-23 00:00",
	"PublishingPoints" : [{
			"Region" : "North America - Ashburn",
			"Url" : "rtmp:\/\/fso.dca.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "North America - Los Angeles",
			"Url" : "rtmp:\/\/fso.oxr.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "Europe - Amsterdam",
			"Url" : "rtmp:\/\/fso.ams.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "Australia - Sydney",
			"Url" : "rtmp:\/\/fso.syd.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "Europe - Frankfurt",
			"Url" : "rtmp:\/\/fso.fra.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "Asia - Hong Kong",
			"Url" : "rtmp:\/\/fso.hhp.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}, {
			"Region" : "Europe - Stockholm",
			"Url" : "rtmp:\/\/fso.arn.0001.edgecastcdn.net\/200001\/default\/<streamName>?adbe-live-event=event1"
		}
	],
	"HLSPlaybackUrl" : "http:\/\/wpc.0001.edgecastcdn.net\/hls-live\/200001\/default\/event1\/<streamName>.m3u8",
	"HDSPlaybackUrl" : "http:\/\/wpc.0001.edgecastcdn.net\/hds-live\/200001\/default\/event1\/<streamName>.f4m",
	"Encrypted" : false,
	"DvrDuration" : null,
	"SegmentSize" : 10
}

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.edgecast.com/v2/mcc/customers/0001/httpstreaming/livehlshds/15 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/xml

Host:api.edgecast.com

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

Content-Length: 2051

<HlsHds xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>137</Id>
	<EventName>event1</EventName>
	<InstanceName>default</InstanceName>
	<KeyFrameInterval>3</KeyFrameInterval>
	<Expiration>2024-03-23 00:00</Expiration>
	<PublishingPoints>
		<PublishingPoints>
			<Region>North America - Ashburn</Region>
			<Url>rtmp://fso.dca.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>North America - Los Angeles</Region>
			<Url>rtmp://fso.oxr.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>Europe - Amsterdam</Region>
			<Url>rtmp://fso.ams.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>Australia - Sydney</Region>
			<Url>rtmp://fso.syd.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>Europe - Frankfurt</Region>
			<Url>rtmp://fso.fra.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>Asia - Hong Kong</Region>
			<Url>rtmp://fso.hhp.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
		<PublishingPoints>
			<Region>Europe - Stockholm</Region>
			<Url>rtmp://fso.arn.0001.edgecastcdn.net/200001/default/&amp;lt;streamName&amp;gt;?adbe-live-event=event1</Url>
		</PublishingPoints>
	</PublishingPoints>
	<HLSPlaybackUrl>http://wpc.0001.edgecastcdn.net/hls-live/200001/default/event1/&amp;lt;streamName&amp;gt;.m3u8</HLSPlaybackUrl>
	<HDSPlaybackUrl>http://wpc.0001.edgecastcdn.net/hds-live/200001/default/event1/&amp;lt;streamName&amp;gt;.f4m</HDSPlaybackUrl>
	<Encrypted>false</Encrypted>
	<DvrDuration i:nil="true"/>
	<SegmentSize>10</SegmentSize>
</HlsHds>