Streams
Streams API endpoints
Streams are representations of video to be worked on by miners on the VideoCoin Network and output consumable video based on the transcoding profile given at creation.
Streams currently support video input over RTMP, WebRTC and FILE.

Properties

Property
Description
id
ID that VideoCoin uses to uniquely identify each stream
name
Name of the stream
output_url
Unique output URL of transcoded video
stream_contract_id
Stream ID in VideoCoin stream chain
stream_contract_address
Stream hex address in VideoCoin chain. Empty until stream is in prepared state
status
Status of the stream's operational state
Read "List of stream statuses" for more information
input_type
Type of input to create stream with
Read "List of input types" for more information
output_type
Type of output stream to produce
Read "List of output types" for more information
input_status
Status of the stream's video ingest
Read "List of ingest statuses" for more information
created_at
Date and time of when stream was initially created
updated_at
Date and time of when stream's state was last changed
ready_at
Date and time of when stream's ingest has received and completed processing input video data. This field will be null until stream is in ready state
completed_at
Date and time of when stream was called to stop. This field will be null until stream is in completed state
rtmp_url
Unique ingest RTMP URL for stream to receive video data from encoder. This URL is used for your encoder to send data to

List of stream statuses (status)

The status of a stream is affected by API calls made on a stream object. Below are the states that describe the lifecycle of a stream:
Status
Description
STREAM_STATUS_NEW
Initially created and no actions have been taken
STREAM_STATUS_PREPARING
Running and preparing input and output destinations
STREAM_STATUS_PREPARED
Preparation is finished and is ready to consume input data
STREAM_STATUS_PENDING
Receiving data and pending on miner to be assigned to stream
STREAM_STATUS_PROCESSING
Miner has started work on stream, but output is not ready for use
STREAM_STATUS_READY
Output destination is ready to be consumed
STREAM_STATUS_COMPLETED
Stream has successfully transcoded video and stream was explicitly stopped or encoder has stopped
STREAM_STATUS_CANCELLED
Stream has not yet received any input data and has been cancelled
STREAM_STATUS_FAILED
Stream has attempted to transcode video received, but problems with the transcoder or account caused it to fail

List of input type (input_type)

The type of input to be provided to ingest stream.
Input Type
Description
INPUT_TYPE_RTMP
The stream will be ingested over RTMP protocol
INPUT_TYPE_WEBRTC
The stream will be ingested over WEBRTC protocol
INPUT_TYPE_FILE
The stream will be ingested by file upload or file link

List of output type (input_type)

The type of output to be produces by stream.
Input Type
Description
OUTPUT_TYPE_HLS
HLS playlist LIVE or VOD depends on stream input type

List of ingest statuses (input_status)

The status of a stream's ingest is affected by the state of the encoder that's sending video data to the stream. Below are the states the ingest can be in:
Ingest Status
Description
INPUT_STATUS_NONE
The stream has been created or has ended and is not receiving any input
INPUT_STATUS_PENDING
Ingest is awaiting for incoming data
INPUT_STATUS_ACTIVE
Ingest is receiving data
INPUT_STATUS_ERROR
Ingest has been failed to process incoming data
get
https://console.videocoin.network/api
/v1/streams
Get Streams
get
https://console.videocoin.network/api
/v1/streams/{id}
Get Stream
post
https://console.videocoin.network/api
/v1/streams
Create Stream
delete
https://console.videocoin.network/api
/v1/streams/{id}
Delete Stream
post
https://console.videocoin.network/api
/v1/streams/{id}/run
Run Stream
post
https://console.videocoin.network/api
/v1/streams/{id}/stop
Stop Stream
Last modified 1yr ago