Live Station overview

Prev Next

Available in Classic and VPC

Live Station is a NAVER Cloud Platform's video encoding platform service that provides all the features required to build a live stream service. The Live Station service provides live channel management, short clip/live curtain creation and management, image quality management, re-stream channel management, VOD2LIVE channel management, and event management features in the RESTful API form.

Common Live Station settings

The following describes commonly used request and response formats in Live Station APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://livestation.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
  • Unix timestamp format.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
Content-Type Required Request data format
  • application/json
x-ncp-region_code Required Region code
  • KR (valid value)

Response

The following describes the common response format.

Response body

The response body includes the following data:

error

error defines the API call failure information. The following describes error.

Field Type Required Description
error Object - Error code and message
error.errorCode String Required Error code
error.message String Required Error message
error.errorName String Required Error name

Response status codes

For information about the HTTP status codes common to all Live Station APIs, see Live Station response status codes.

Note

For information about the HTTP status codes common to all NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
    "error": {
        "errorCode": 250000,
        "message": "Unexpected error occurred.",
        "errorName": "EXCEPTION"
    }
}

Live Station API

The following describes the APIs provided by the Live Station service.

Channel Management

This section describes the APIs related to channel management.

Channel

The following describes the channel-related APIs.

API Description
Create channel Create Live channel.
Get channel list Get live channel list.
Get channel stream metadata Get outgoing stream metadata for a live channel.
Get channel Get live channel details.
Get channel service URL Get channel live playback URL, time machine URL, and thumbnail URL.
Change channel settings Change live channel settings.
Stop channel Stop live channel.
Remove channel suspension Enable stopped live channel.
Change channel CDN Change the integrated CDN server for a live channel.
Bulk change channel CDNs Bulk change the integrated CDN servers for two or more live channels.
Channel termination Terminate Live channel.

Recording

The following describes the recording-related APIs.

API Description
Start recording Start recording while streaming channel.
Stop recording Channel recording ended
Upload recording file Upload recording file to Object Storage bucket.
Get recording file list Get recording file list.
Get recording file Get recording file details.
Delete recording file Delete recording file.

Short Clip

The following describes the APIs related to short clip.

API Description
Create snapshot Create a snapshot of a live channel that is streaming.
Get snapshot Get snapshot details.
Create short clip Create a live short clip based on a snapshot.
Get short clip list Get live short clip list.
Get short clip Get live short clip details.

Live Curtain

The following describes the APIs related to live curtain.

API Description
Create live curtain content Create content to be used for live curtain.
Get live curtain content list Get live curtain content list.
Get live curtain content Get live curtain content details.
Delete live curtain content Delete live curtain content.
Start live curtain Start live curtain streaming.
End live curtain Force end live curtain streaming.

Quality Management

This section scribes the APIs related to quality management.

Quality Profile

The following describes the APIs related to quality profile.

API Description
Get image quality list Get complete image quality list.
Get image quality Get complete image quality details.
Create custom image quality Create custom image quality.
Delete custom image quality Delete custom image quality.

Quality Setting

The following describes the APIs related to quality setting.

API Description
Get image quality settings list Get complete image quality settings list.
Get image quality settings Get complete image quality settings details.
Create custom image quality settings Create custom image quality settings.
Edit custom image quality settings Edit custom image quality settings.
Delete custom image quality settings Delete custom image quality settings.

Re-Stream Management

This section describes the APIs related to re-stream management.

API Description
Create channel Create re-stream channel.
Get re-stream platform list Get re-stream platform list.
Get channel list Get re-stream channel list.
Get channel Get re-stream channel details.
Edit re-stream platform Edit re-stream platform information.
Channel termination Terminate re-stream channel.

VOD2LIVE Management

This section describes the APIs related to VOD2LIVE management.

Channel

The following describes the channel-related APIs.

API Description
Create channel Create VOD2LIVE channel.
Get channel list Get VOD2LIVE channel list.
Get channel Get VOD2LIVE channel details.
Get channel service URL Get VOD2LIVE channel playback URL and thumbnail URL.
Change channel settings Change VOD2LIVE channel settings.
Stop channel Stop VOD2LIVE channel.
Remove channel suspension Enable stopped VOD2LIVE live channel.
Change channel CDN Change CDN server connected to VOD2LIVE channel.
Bulk change channel CDNs Bulk change CDN servers for multiple VOD2LIVE channels.
Channel termination Terminate VOD2LIVE channel.

Schedule

The following describes the schedule-related APIs.

API Description
Create schedule Create VOD streaming schedule.
Get schedule Get VOD streaming schedule.
Edit schedule Edit VOD streaming schedule.
Delete schedule Delete VOD streaming schedule.

Event

The following describes the event-related APIs.

API Description
Get admin group list Get admin group list.
Get admin Get admin information.
Set event notifications Set event notifications.
Get event list Get the list of events for all channels.
Get live channel streaming event list Get the list of streaming events for a live channel.
Get live channel event list Get the list of events for a live channel.
Get re-stream channel streaming event list Get the list of streaming events for a re-stream channel.
Get re-stream channel event list Get the list of events for a re-stream channel.
Register callback endpoint Register default callback endpoint that will receive event notifications for all channels.
Register callback endpoint (live) Register callback endpoint that will receive event notifications for live channels.
Register callback endpoint (re-stream) Register callback endpoint that will receive event notifications for re-stream channels.
Register callback endpoint (VOD2LIVE) Register callback endpoint that will receive event notifications for VOD2LIVE channels.
Get callback endpoint Get registered callback endpoint.

Live Station related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Live Station APIs.