Classes
Response<[TYPE]
>
[TYPE]
>Type | Name | Optional | Description | Examples |
Int | statusCode | N | Status code |
|
String | message | N | A message describing the value returned |
|
| response | Y | A response data |
|
VirtualHost
Type | Name | Optional | Description | Examples |
String | name | N | A name of Virtual Host |
|
| td | Y | Host |
|
| signedPolicy | Y | SignedPolicy |
|
| signedToken | Y | SignedToken |
|
List< | td | Y | A list of Origin map |
|
Host
Type | Name | Optional | Description | Examples |
List<String> | td | N | A list of hosts |
|
Tls | td | Y | TLS |
|
TLS
Type | Name | Optional | Description | Examples |
String | certPath | N | A path of cert file |
|
String | keyPath | N | A path of private key file |
|
String | chainCertPath | Y | A path of chain cert file |
|
SignedPolicy
Type | Name | Optional | Description | Examples |
String | policyQueryKey | N | ||
String | signatureQueryKey | N | ||
String | secretKey | N |
SignedToken
Type | Name | Optional | Description | Examples |
String | cryptoKey | N | ||
String | queryStringKey | N |
OriginMap
Type | Name | Optional | Description | Examples |
String | location | N | A pattern to map origin |
|
| pass | N | What to request with Origin if the pattern matches |
|
Pass
Type | Name | Optional | Description | Examples |
String | scheme | N | Scheme to distinguish the provider |
|
List<String> | urls | N | An address list to pull from provider |
|
Application
Type | Name | Optional | Description | Examples |
String | name | N | App name (You cannot change this value after you create it) |
|
Bool | dynamic | N | Whether the app was created using |
|
Enum< | type | N | App type |
|
| providers | Y | A list of |
|
| publishers | Y | A list of |
|
List< | outputProfiles | Y | A list of |
|
Providers
Type | Name | Optional | Description | Examples |
| rtmp | Y |
| |
| rtspPull | Y |
| |
| rtsp | Y |
| |
| ovt | Y |
| |
| mpegts | Y |
|
RtmpProvider
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
RtspPullProvider
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
RtspProvider
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
OvtProvider
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
MpegtsProvider
Type | Name | Optional | Description | Examples |
List< | streams | Y | MPEG-TS Stream map |
|
MpegtsStream
Type | Name | Optional | Description | Examples |
String | name | N | A name to generate when MPEG-TS stream is received |
|
| port | Y | MPEG-TS Port |
|
Publishers
Type | Name | Optional | Description | Examples |
Int | threadCount | N | Number of threads |
|
| rtmpPush | Y |
| |
| hls | Y |
| |
| dash | Y |
| |
| llDash | Y |
| |
| webrtc | Y |
| |
| ovt | Y |
| |
| file | Y |
| |
| thumbnail | Y |
|
RtmpPushPublisher
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
HlsPublisher
Type | Name | Optional | Description | Examples |
Int | segmentCount | N | Segment count in the playlist.m3u8 |
|
Int | segmentDuration | N | Segment duration (unit: seconds) |
|
List<String> | crossDomains | Y | Cross domain URLs |
|
DashPublisher
Type | Name | Optional | Description | Examples |
Int | segmentCount | N | Segment count in the manifest.mpd |
|
Int | segmentDuration | N | Segment duration (unit: seconds) |
|
List<String> | crossDomains | Y | Cross domain URLs |
|
LlDashPublisher
Type | Name | Optional | Description | Examples |
Int | segmentDuration | N | Segment duration (unit: seconds) |
|
List<String> | crossDomains | Y | Cross domain URLs |
|
WebrtcPublisher
Type | Name | Optional | Description | Examples |
| timeout | Y | ICE timeout (unit: seconds) |
|
OvtPublisher
Type | Name | Optional | Description | Examples |
(Reserved for future use) | - | - | - |
FilePublisher
Type | Name | Optional | Description | Examples |
String | filePath | Y | A path to store recorded file
You can use the following macros:
|
|
String | fileInfoPath | Y | A path of recorded files |
|
ThumbnailPublisher
Type | Name | Optional | Description | Examples |
List<String> | crossDomains | Y | Cross domain URLs |
|
OutputProfile
Type | Name | Optional | Description | Examples |
String | name | N | A name of |
|
String | outputStreamName | N | A name of output stream |
|
| encodes | Y |
|
Encodes
Type | Name | Optional | Description | Examples |
List< | videos | Y |
| |
List< | audios | Y |
| |
List< | images | Y |
|
Video
Type | Name | Optional | Description | Examples |
Bool | bypass | Y |
| |
Enum< | codec | Conditional | Video codec |
|
Int | width | Conditional |
| |
Int | height | Conditional |
| |
String | bitrate | Conditional | bitrate (You can use "K" or "M" suffix like |
|
Float | framerate | Conditional |
|
Audio
Type | Name | Optional | Description | Examples |
Bool | bypass | Y |
| |
Enum< | codec | Conditional | Audio codec |
|
Int | samplerate | Conditional |
| |
Int | channel | Conditional |
| |
String | bitrate | Conditional | bitrate (You can use "K" or "M" suffix like |
|
Image
Type | Name | Optional | Description | Examples |
Enum< | codec | N |
| |
Int | width | Conditional |
| |
Int | height | Conditional |
| |
Float | framerate | N | An interval of image creation |
|
Stream
Type | Name | Optional | Description | Examples |
String | name | N | A name of stream |
|
| input | N | An information of input stream |
|
List< | outputs | N | An information of output streams |
|
NewStream
Type | Name | Optional | Description | Examples |
String | name | N | A name of stream to create |
|
| pull | Y | pull |
|
| mpegts | Y | Creates a |
|
PullStream
Type | Name | Optional | Description | Examples |
String | url | N | URL to pull |
|
InputStream
Type | Name | Optional | Description | Examples |
String | agent | Y | A name of broadcast tool |
|
String | from | N | URI stream created |
|
String | to | Y | URI represents connection with the input |
|
List< | tracks | N | A list of tracks in input stream |
|
| createdTime | N | Creation time |
|
OutputStream
Type | Name | Optional | Description | Examples |
String | name | N | An name of |
|
List< | tracks | N | A list of tracks in |
|
Track
Type | Name | Optional | Description | Examples |
Enum< | type | Y | Media type |
|
| video | Conditional | A configuration of video encoding |
|
| audio | Conditional | A configuration of audio encoding |
|
VideoTrack
Type | Name | Optional | Description | Examples |
(Extends | - | - | ||
| timebase | Y | Timebase |
|
Timebase
Type | Name | Optional | Description | Examples |
Int | num | N | Numerator |
|
Int | den | N | Denominator |
|
AudioTrack
Type | Name | Optional | Description | Examples |
(Extends | - | - |
| |
| timebase | Y | Timebase |
|
Record
Type | Name | Optional | Description | Examples |
String | id | Y | Unique identifier | |
| streams | N | A combination of output stream's track name and track id | |
Enum< | state | N | Record state | |
String | filePath | N | A path of recorded files | |
String | fileInfoPath | N | A path of recorded file informations | |
String | recordedBytes | N | Recorded bytes | |
Int | recordedTime | N | Recorded time | |
| startTime | N | Started time | |
| finishTime | N | Finished time | |
Int | bitrate | N | Average bitrate |
Push
Type | Name | Optional | Description | Examples |
String | id | N | Unique identifier | |
| stream | Y | A combination of output stream's track name and track id | |
Enum< | protocol | Y | Protocol of input stream | |
String | url | Y | Destination URL | |
String | streamKey | Conditional | Stream key of destination | |
Enum< | state | N | Push state | |
Int | sentBytes | N | Sent bytes | |
Int | sentPackets | N | Sent packets count | |
Int | sentErrorBytes | N | Error bytes | |
Int | sentErrorPackets | N | Error packets count | |
Int | reconnect | N | Reconnect count | |
| startTime | N | Started time | |
| finishTime | N | Finished time | |
Int | bitrate | N | Average bitrate |
CommonMetrics
Type | Name | Optional | Description | Examples |
| createdTime | N | Creation time |
|
| lastUpdatedTime | N | Modified time |
|
Long | totalBytesIn | N | Received bytes |
|
Long | totalBytesOut | N | Sent bytes |
|
Int | totalConnections | N | Current connections |
|
Int | maxTotalConnections | N | Max connections since the stream is created |
|
| maxTotalConnectionTime | N | When the maximum number of concurrent connections has been updated. |
|
| lastRecvTime | N | Last time data was received |
|
| lastSentTime | N | Last time data was sent |
|
StreamMetrics
Type | Name | Optional | Description | Examples |
(Extends | - | - | Includes all fields of | |
| requestTimeToOrigin | Y | A elapsed time to connect to Origin |
|
| responseTimeFromOrigin | Y | A elapsed time from Origin to respond |
|
Last updated