Sha256: 2672ff8c94c8a4d3c2a298213fa5c8408052b4d46f541ba83fd45fc4be3e88a1
Contents?: true
Size: 1.86 KB
Versions: 14
Compression:
Stored size: 1.86 KB
Contents
# Requests
## Defaults request
By default this gem contains many request :
```linux
├── admin
│ ├── handle_info.json
│ ├── handles.json
│ ├── log_level.json
│ └── sessions.json
├── base
│ ├── attach.json
│ ├── create.json
│ ├── destroy.json
│ ├── detach.json
│ ├── info.json
│ └── keepalive.json
├── peer
│ ├── answer.json
│ ├── offer.json
│ ├── trickle.json
```
* Folder `admin` contains admin requests for interact with Janus Admin/Monitor
API. [See official docs.](https://janus.conf.meetecho.com/docs/admin.html)
* Folder `base` contains base requests for interact with Janus.
## Request files
All request is writing in JSON format and contains many informations.
Example base request with type `'base::info'` :
```json
{
"janus": "info",
"transaction": "<string>"
}
```
For more explain to construct request sending to Janus [see official documentation](https://janus.conf.meetecho.com/docs/rest.html).
Some fields are customizables. For this fields is a gem to apply a transformation :
* session_id
* handle_id
* transaction
* candidate
* admin_secret - *just for admin secret*
* level - *just for admin secret*
Each fields use an type :
* "\<number\>" - Is a integer
* "\<number\>" - Is a integer
* "\<string\>" - Is a string
* "\<plugin[X]\>" - Is a plugin with X is a key to array in config file
* "\<array\>" - Is a array. If array contains a single value is transform to string format.
## Complex request
Example peer request with type `'peer:offer'` :
```json
{
"janus": "message",
"session_id": "<number>",
"handle_id": "<number>",
"transaction": "<string>",
"body": {
"audio": "true",
"video": "true"
},
"jsep": {
"type": "offer",
"sdp": "<string>"
}
}
```
Version data entries
14 entries across 14 versions & 1 rubygems