Aten StreamLIVE PRO UC9040 [2/40] Introduction
![Aten StreamLIVE PRO UC9040 [2/40] Introduction](/views2/1978089/page2/bg2.png)
1
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.
Introduction
The information enclosed defines ATEN’s RESTful APIs — RESTlink. Each authorized client can configure
and control ATEN devices via these APIs, with all request and response messages encoded in JSON.
Table of Contents
Introduction ....................................................................................................................................................... 1
API Request Methods ......................................................................................................................................... 3
1 GET ............................................................................................................................................................... 3
2 POST ............................................................................................................................................................. 3
3 PATCH ........................................................................................................................................................... 3
4 DELETE .......................................................................................................................................................... 3
APIs Request Header Authentication ................................................................................................................. 3
1 Response ...................................................................................................................................................... 4
1.1 Status Codes .................................................................................................................................. 4
2 Authentication ............................................................................................................................................ 7
2.1 User Login ...................................................................................................................................... 7
2.2 User Logout ................................................................................................................................... 8
2.3 Modify Authorization .................................................................................................................... 9
3 Audio ......................................................................................................................................................... 10
3.1 Get All Audio ............................................................................................................................... 10
3.2 List All Input ................................................................................................................................ 11
3.3 Get One Input .............................................................................................................................. 12
3.4 Set One Input .............................................................................................................................. 14
3.5 List All Output.............................................................................................................................. 15
3.6 Get One Output ........................................................................................................................... 17
3.7 Set One Output ........................................................................................................................... 18
4 Transition................................................................................................................................................... 20
4.1 Transition Status .......................................................................................................................... 20
4.2 Start Transition ............................................................................................................................ 21
4.3 Get Transition .............................................................................................................................. 22
4.4 Set Transition .............................................................................................................................. 23
Содержание
- Uc9040 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
- User login 8
- User logout 9
- Api api v1 auth login authorization request patch modifies the login authorization for api access control management header 10
- Error 500 internal server error 10
- Modify authorization 10
- Response success 10
- Get all audio 11
- List all input 12
- Get one input 13
- Header 14
- Response 14
- Success 200 ok 14
- Error 500 internal server error 15
- Request 15
- Set one input 15
- Set one input sets a specified audio input s configurations this is an asynchronous setting function api api v1 audio input id request patch set a specified audio input s configurations header 15
- List all output 16
- Api api api v1 audio output id request get get a specified audio output s configuration header 18
- Get one output 18
- Get one output get one output contains a specified audio output s configurations 18
- Response success 200 ok 18
- Set one output 19
- Error 500 internal server error 20
- Header 20
- No contents 20
- Request 20
- Request patch set a specified audio output s configuration 20
- Response success 20
- Transition 21
- Transition status 21
- Api v1 transition request post start the video transition header 22
- Error 500 internal server error 22
- Request 22
- Start transition 22
- Start transition start transition starts the video transition api 22
- Get transition 23
- Error 500 internal server error 24
- Request 24
- Request request patch set the video transition header 24
- Set transition 24
- Set transition set transition sets the video transition api api v1 transition 24
- Duration integer special default value represent position change duration when transition mode auto and defined in millisecond 25
- Effect integer 25
- Error 500 internal server error 25
- Field type description 25
- Internalservererror internal server error occurred 25
- Name description 25
- Quickswitch boolean special value to open quick switch setting 25
- Response success 25
- Sender optional string for event information default value web 25
- Special default value representing transition change effect when transition mode auto 25
- Get get the entire program s streaming configuration header 26
- Get status 26
- Response success 26
- Streamer 26
- Streamer group apis are special purpose apis for handling program streaming control management 5 get status get status contains the entire program s streaming configurations api api v1 streamer status request 26
- Error 500 internal server error 27
- Start streaming 28
- Pause streaming 29
- Stop streaming 29
- Resume streaming 30
- Get all 31
- Source 31
- List all videos 32
- Get video 33
- Error 500 internal server error 34
- Response success 200 ok 34
- Channel 35
- List all channels 35
- Get channel 36
- Set switch mode 37
- Error 500 internal server error 38
- Request 38
- Response 38
- Success 200 ok 38
- Api api v1 channels id request patch set a specified channel s configuration header 39
- Request 39
- Response success 200 ok 39
- Set channel 39
- Set channel set channel sets a specified channel s configurations 39
Похожие устройства
- Aten StreamLIVE PRO UC9040 Руководство пользователя
- Aten StreamLIVE PRO UC9040 Краткое руководство по установке
- Aten StreamLIVE PRO UC9040 Руководство пользователя 2
- Aten CAMLIVE PRO UC3022 Краткое руководство по установке
- Aten CAMLIVE PRO UC3022 Руководство пользователя
- Aten CAMLIVE + UC3021 Краткое руководство по установке
- Aten CAMLIVE + UC3021 Руководство пользователя
- Aten StreamLIVE HD UC9020 RESTful API Инструкция
- 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 Краткое руководство по установке