JSON Attributes


JSON: Stream-Options

{ "audio": true, /* Published with Audio */ "video": true, /* Published with Video */ "data": true, /* Text-Chat Enabled */ "screen": false, /* Screen Share disabled */ "videoSize": [minWidth, minHeight, maxWidth, maxHeight], "audioMuted": true, /* Audio muted on entry to room */ "videoMuted": true, /* Video muted on entry to room */ "attributes": { /* Custom Key=Value to be defined */ "name":'myStream' }, "options": {} /* Video Player Options. Ref Appendix Player Options */ }

JSON: Room-Meta

{ "name": "String", /* Room name */ "owner_ref": "String", /* Owner Reference */ "settings": {}, /* Settings */ "sip": {}, /* SIP Configuration */ "data": {}, /* Optional Data Structure */ "id": "String", /* Room ID */ "streams": [], /* All Streams published */ "userList": [{}], /* All Users connected */ "awaitedParticipants": [], /* All Users waiting to get into room */ "raisedHands": [], /* Raised hands in lecture mode */ "approvedHands": [], /* Approved hands in lecture mode */ "activeTalkers": [], /* Active talkers list */ "recording": false, /* Recording State flag */ "hardmute": false /* Hard Mute State flag */ }

JSON: User-Meta

{ "clientId": "String", /* Client-ID assigned by Sig Server */ "name": "String", /* Name of the User */ "user_ref": "sdfds", /* User Reference */ "role": "participant", /* User Role */ "permissions": { /* User Permissions */ "publish": true, "subscribe": true, "record": false, "stats": true, "controlhandlers": true } }

JSON: Player-Options

{ "playerID": "", /* Unique Player ID */ "elementID": "", /* DIV DOM Element ID */ "backgroundImg": "", /* Image URL if no Video */ "attachMode": "", /* replace, append (default), prepend*/ "branding": { /* Logo Branding on Player Area */ "clickthru":"", /* Clickthrough URL */ "logo": "", /* Logo URL */ "title": "", /* Title of Branding / Logo */ "position":"topRight" /* topLeft, topRight, bottomLeft, bottomRight */ }, "loader": { "show": "true", /* Whether to show Loader Animation */ "url": "", /* Custom Animation URL */ "class": "" /* Custom CSS Class Name */ }, "player": { "autoplay": "", /* default "autoplay" */ "name": "", /* Use stream.attributes.name preferably */ "nameDisplayMode": "", /* auto (default), on, off*/ "frameFitMode": "", /*bestFit (default), coverMax*/ "skin":"default", /* Other constants TBD */ "class": "", /* Custom CSS Class Name */ "height": "", /* Player Height in Px */ "width":"", /* Player Width in Px */ "minHeight": "", /* Player Min Height in Px */ "minWidth": "", /* Player Min Width in Px */ "volume": "0" /* default to 0, muted */ } }

JSON: room-connected

{ "result": 0, "streams": [{ "id": 1, "audio": true, "video": true, "data": true, "screen": false, "attributes": {} }], "id": "", "clientId": "", "user": { "name": "mod", "user_ref": "mod", "role": "moderator", "permissions": { "publish": true, "subscribe": true, "record": true, "stats": true, "controlhandlers": true }, "clientId": "" }, "room": { "name": "test!", "owner_ref": "xx@vcloudx.com", "settings": { "description": "test!", "scheduled": false, "adhoc": false, "participants": "9", "auto_recording": false, "active_talker": true, "quality": "HD", "mode": "group", "moderators": "1" }, "sip": { "enabled": false, "uri": "", "name": "", "auth": "", "secret": "", "proxy": "", "aor": [] }, "created": "YYYY-MM-ddTHH:mm:ss.000Z", "_id": "" }, "userList": [ /* user-meta */ ], "raisedHands": [], "approvedHands": [], "awaitedParticipants": [], "defaultVideoBW": 4096, "maxVideoBW": 4096 }

JSON: stream-subscribed

{ "type": "stream-subscribed", "stream": { "config": { "streamID": 1, "local": false, "audio": true, "video": true, "data": true, "screen": false, "attributes": {} }, "stream": {}, "showing": false, "local": false, "video": true, "audio": true, "screen": false, "audioMuted": false, "videoMuted": false, "hardAudioMuted": false, "hardVideoMuted": false, "attributes": {}, "Connection": {}, "pc": { "pcConfig": { "iceServers": [{ "urls": ["turn:turnserver.vcloudx.lan:3478?transport=udp"], "username": "boby", "credential": "ram" }, { "urls": ["turn:turnserver.vcloudx.lan:3478?transport=tcp"], "username": "boby", "credential": "ram" }, { "urls": ["turn:turnserver.vcloudx.lan:443?transport=tcp"], "username": "boby", "credential": "ram" }, { "urls": ["stun:stun.l.google.com:19302"] }] }, "con": {}, "mediaConstraints": { "offerToReceiveVideo": true, "offerToReceiveAudio": true }, "peerConnection": { "_eventMap": {} } } } }

JSON: user-disconnected

{ "type": "user-disconnected", "name": "part1", "role": "participant", "permissions": { "publish": true, "subscribe": true, "record": false, "stats": true, "controlhandlers": true } }

JSON: token

{ "tokenId": "5b8d1d5fd828770b7056ba21", "roomMeta": { "name": "EnableX room", "owner_ref": "sohom.h@vcloudx.com", "settings": { "description": "token response from Signaling Server", "scheduled": false, "adhoc": false, "participants": "9", "auto_recording": false, "active_talker": true, "quality": "HD", "mode": "group", "moderators": "1" }, "sip": { "enabled": false, "uri": "", "name": "", "auth": "", "secret": "", "proxy": "", "aor": [] }, "created": "2018-08-29T13:00:30.782Z", "_id": "5b8698ee527f391e19941c05" }, "host": "mediaserver-dev.vcloudx.com:8080", "secure": true, "logId": "ZPZcoQ", "gateway": "", "signature": "YzM2NDhkMjUzZGYwOTQ0ZTBlMGU4ZGJmYWQyNThkMTZlZjIzZDViMw==", "version": "0.1" }