![Aten StreamLIVE HD UC9020 [29/52] Get status get status contains the entire program s streaming configurations api api v2 streamer status request get get the entire program s streaming configuration header](/img/pdf.png)
Aten StreamLIVE HD UC9020 [29/52] Get status get status contains the entire program s streaming configurations api api v2 streamer status request get get the entire program s streaming configuration header
![Aten StreamLIVE HD UC9020 [29/52] Get status get status contains the entire program s streaming configurations api api v2 streamer status request get get the entire program s streaming configuration header](/views2/1978097/page29/bg1d.png)
28
All information, documentation and specifications contained in this media are subject to change without prior notice by the manufacturer. Please
visit our website to find the most up-to-date version.
5 Streamer
Streamer group APIs are special-purpose APIs, for handling program streaming control management.
5.1 Get Status
Get status contains the entire program’s streaming configurations.
API
/api/v2.0/streamer/status
Request
GET: get the entire program’s streaming configuration.
Header
Field
Type
Description
Authorization
String
The special credential value.
Response
Success
200 OK
Field
Type
Description
egnId
Integer
The streaming engine ID.
egnStatus
String
The streaming engine status. Allowed values: "start", "stop"
time
Integer
The streaming duration time.
overallStatusIdx
Integer
The overall streaming status index.
overallStatusMsg
String
The overall streaming status message.
overallStatusIdx
overallStatusMsg
0
not connected
1
disconnecting
2
connecting
3
connecting failed
4
streaming
5
pausing
6
paused
7
resuming
stream
Object[]
The streaming task information list.
obj
Object
The streaming information object.
id
Integer
The stream data index number.
name
String
The stream data name.
category
String
The stream category. Allowed values: "streaming", "recording"
type
String
The stream type.
For streaming : rtp / rtmp
For recording : usb / cloud
Allowed values: rtp, rtmp, usb, cloud
bitrate
Integer
The streaming bitrate.
connQuality
Integer
The streaming connection quality. { -1: null, 0: Good, 1: Ok, 2: Bad }
statusIdx
Integer
Streaming status index number.
recStatusIdx
Integer
Recording status index number.
statusMsg
String
Message content decide by stream category
Streaming status description messages.
Содержание
- Uc9020 restful api 1
- Introduction 2
- Api request methods 4
- Apis request header authentication 4
- Delete 4
- Response 4
- Api response error handling 5
- Apis server alive testing 5
- Response 5
- Status codes 5
- Message body in the following format 6
- Response messages in addition to status codes aten devices also enclose the related detailed descriptions within the http 6
- Authentication 8
- Authentication group apis are for handling api access control management 2 user login api api v2 auth login post logs in for api access control management body 8
- Error 401 unauthorized 8
- Response success 200 ok 8
- User login 8
- User logout 9
- Modify authorization 10
- Get all audio 12
- List all input 13
- Api api v2 audio input id request get get a specified audio input s configuration header 15
- Get one input 15
- Get one input get one input contains a specified audio input s configurations 15
- Response success 200 ok 15
- Set one input 16
- Error 500 internal server error 17
- Response success 204 no contents 17
- List all output 18
- Api api api v2 audio output id request get get a specified audio output s configuration header 20
- Get one output 20
- Get one output get one output contains a specified audio output s configurations 20
- Response success 200 ok 20
- Response success 204 no contents 22
- Set one output 22
- Set one output set one output sets a specified audio output s configurations 22
- This is an asynchronous setting function api api v2 audio output id request patch set a specified audio output s configuration header 22
- Transition 24
- Transition status 24
- Api v2 transition request post start the video transition header 25
- Request 25
- Response error 500 internal server error 25
- Send a sample request 25
- Start transition 25
- Start transition start transition starts the video transition api 25
- Get transition 26
- Set transition 27
- Get status 29
- Get status get status contains the entire program s streaming configurations api api v2 streamer status request get get the entire program s streaming configuration header 29
- Response success 200 ok 29
- Streamer 29
- Streamer group apis are special purpose apis for handling program streaming control management 29
- Error 500 internal server error 30
- Start streaming 31
- Stop streaming 32
- Pause streaming 33
- Resume streaming 34
- Get all 35
- Source 35
- List all videos 36
- Api api api v2 source video id request get get the video configuration header 38
- Get video 38
- Get video get video contains the video configurations 38
- Response success 200 ok 38
- List all audio 39
- Error 500 internal server error 40
- Header 40
- Request get get the entire audio configurations 40
- Response success 200 ok 40
- Get audio 41
- Get audio get video contains the audio configurations api api v2 source audio id request get get the audio configuration header 41
- Response success 200 ok 41
- Send a sample request 41
- Error 500 internal server error 42
- Send a sample request 42
- Api api v2 source audio id request patch set the audio configuration header 43
- Response success 200 ok 43
- Set audio 43
- Set audio set audio sets the audio configurations 43
- Channel 46
- List all channels 46
- Get channel 47
- Error 500 internal server error 48
- Response success 200 ok 48
- Send a sample request 48
- Api api v2 channels request patch set the switch mode header 49
- Response success 200 ok 49
- Set switch mode 49
- Set switch mode set switch mode sets the switch mode 49
- Set channel 50
- Error 500 internal server error 51
- Response success 51
Похожие устройства
- Aten StreamLIVE HD UC9020 Руководство по программному обеспечению
- Aten StreamLIVE HD UC9020 Краткое руководство по установке
- Aten StreamLIVE HD UC9020 Руководство пользователя
- Aten CAMLIVE UC3020 Краткое руководство по установке
- Aten CAMLIVE UC3020 Руководство пользователя
- Aten US3342 Краткое руководство по установке
- Aten US3342 Руководство пользователя
- Aten US3344 Краткое руководство по установке
- Aten UH3239 Руководство пользователя
- Aten UH3239 Краткое руководство по установке
- Aten US3324 Краткое руководство по установке
- Aten UH3238 Краткое руководство по установке
- Aten UH3238 Руководство пользователя
- Aten US3344I Руководство пользователя
- Aten US3344I Краткое руководство по установке
- Aten UH3237 Руководство пользователя
- Aten UH3237 Краткое руководство по установке
- Aten UH3234 Руководство пользователя
- Aten UH3234 Краткое руководство по установке
- Aten UH3235 Краткое руководство по установке