The Avaya Spaces socket server will emit this socket event when a SEND_MEDIA_SESSION_EVENTS socket event was sent by another member of the channel.

Payload Parameters

NameDescriptionJSON type
topicIdUnique identifier of the space.string
senderThe user that sent the SEND_MEDIA_SESSION_EVENTS.
  • _id: unique identifier of the sender
  • username: the username of the sender
  • displayname: the display name of the sender
  • picture_url: URL linking to the profile picture of the user
  • type: what type of sender ('user' or 'anonymous')
string
categoryThe type of media session event.string
content
  • sessionId: (string) Unique identifier of the socket session. Reference only.
  • file: array of objects representing attached files
  • mediaSession: (object) media session state
    • audio: (boolean) is the user sending audio
    • connected: (boolean) is the user connected to the media session
    • screenshare: (boolean) is the user sharing their screen
    • selfMuted: (boolean) is the user muted
    • video: (boolean) is the user sending video
  • streamId: (string, optional) Unique identifier of the local media feed
  • image: (string) URL of screenshare frame image uploaded
  • timeUploaded: (int) UTC timestamp when client uploaded screenshare frame image
  • width: (int) Pixel width of screenshare frame image
  • height: (int) Pixel height of screenshare frame image
object
createdTimestamp of when message item was created.string

Media Session Event Categories

NameDescription
trackstatusChange in state of media session (eg.: user muted/unmuted). The first time trackstatus is sent/received is treated as starting the call.
video.endEnd audio/video call
video.startscreenshareStart sharing screen
video.screenshare.uploadurlReceive a set of urls to upload screen share frames
video.stopscreenshareScreen shared ended
video.screensharedataScreen share frame has been uploaded

Authorization

Subscribed to the channel.

Example

socketConnection.on('MEDIA_SESSION_RESPONSE', callback(payload));

Payload ('video.screenshare.uploadurl')

{
  "topicId": "5949579a7ec01d05d30054e1",
  "sender": {
      "_id": "593807c13b3132a1e27c8065",
      "type": "user"
  },
  "category": "video.screenshare.uploadurl",
  "content": {
    "file": [
        {
            "fileKey": "screen_5949579a7ec01d05d30054e0/1",
            "downloadUrl": "https://storage.googleapis.com/onesna/logan%2Fscreen_5949579a7ec01d05d30054e0%2F1?GoogleAccessId=logan-gcs@onesna-all.esna.com.iam.gserviceaccount.com&Expires=1498855069&Signature=aw%2F83u54zTt%2F%2FlZIJU8bkj3JcP6MPyexf%2F%2Fc8%2FA5S%2Fh2YopGha7EjCwdC%2F4nYvLwtqnupUEOHMH2O7DsjYbC45LxdGjRQC%2BNaaW2Df8FeReeOiOXWOzcb2Lau07TpYQITRDvhBZgfFHuGKm3zPXH83UaBR%2F2V6QrYv0wyxFV0T1CO2J4bRrIhTW%2B%2FI99j%2BZSzFNuGriUUtGIjwMAmjZ8eIDIxJo1hX4tS%2BKlt2gtfOiwI97oqzZMZftrdU0z6roYRGN5eY2kSDcIMH6RktEhQc8tTSezLa%2BE39enr94rMMUAUtVGMDtoOnAFtJdP69a0ocdzAV2yD%2F2Yu0psrmD4Pw%3D%3D",
            "uploadUrl": "https://storage.googleapis.com/onesna/logan%2Fscreen_5949579a7ec01d05d30054e0%2F1?GoogleAccessId=logan-gcs@onesna-all.esna.com.iam.gserviceaccount.com&Expires=1498855069&Signature=SLpNT7uemWJuqKZ9WXURQKl4YDD8DNosVZV8BECWDqNFHgPIGnaisPtwG91%2F%2BGNO2kayBvzZ6c6cUsi%2FUikRrCfIjvHwxH9xwAN0gIKJUImG3HveQmdoeYnPRJFoKJcpYFI%2BLTC0xjmlSArKdmVDhMWcoTN6%2Fwh4eFplgZJ4AwWIidRl8t2bV9ax7%2FyBDHPtwJO9CJ6LNauJ7XVoWcDzpTZKHe9SHIk559kIEteZWqQbiK56I4w0Nlswn9B1%2BOIZdDKrTGAHXtFQV8gKCfAYMXHn7QrKu2wMufFxy2X1e7A2hlR0u3aCrvHEvy1E%2BZSSg7uxGNypGNfCb6JYBDAVWQ%3D%3D"
        }
    ],
    "sessionId": "310c8dd0-e3d4-42dc-de74-a71ca8404d20"
  }
}

Payload ('video.end')

{
  "topicId":"59665be02c305405b327c2d7",
  "sender":{
      "_id":"594957373b3132a1e27c9bc1",
      "type":"user",
      "displayname":"Wesley Frederickson",
      "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_user_20eb0461-475a-42a1-bdfc-3107c148059c",
      "username":"wfrederickson@ryerson.ca"
  },
  "content":{
      "sessionId":"93eb3295-9c8e-4774-944d-e1b147962fa8"
  },
  "created":"2017-07-20T09:14:46-0400",
  "category":"video.end"
}

Payload ('trackstatus')

{
  "topicId":"59665be02c305405b327c2d7",
  "sender":{
      "_id":"594957373b3132a1e27c9bc1",
      "type":"user",
      "displayname":"Wesley Frederickson",
      "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_user_20eb0461-475a-42a1-bdfc-3107c148059c",
      "username":"wfrederickson@ryerson.ca"
  },
  "content":{
      "mediaSession":{
        "video":true,
        "audio":true,
        "connected":true,
        "screenshare":false
      },
      "streamId":"1500556417728",
      "sessionId":"93eb3295-9c8e-4774-944d-e1b147962fa8"
  },
  "created":"2017-07-20T09:13:38-0400",
  "category":"tracksstatus"
}

Payload ('video.startscreenshare')

{
  "topicId":"59665be02c305405b327c2d7",
  "sender":{
      "_id":"593807c13b3132a1e27c8069",
      "type":"user",
      "username":"wesleyf@esna.com",
      "displayname":"Wesley Frederickson",
      "picture_url":"https://accounts.zang.io/norevimages/noimage.jpg"
  },
  "content":{
      "streamId":"TndeYt1yiXxDJHwDz2I2icDvJLY5O6xmWxbN",
      "sessionId":"8c3b5ea1-2250-4226-ffcd-d6df6cddfe44"
  },
  "created":"2017-07-20T13:49:39.464Z",
  "category":"video.startscreenshare"
}

Payload ('video.screensharedata')

{
  "topicId":"59665be02c305405b327c2d7",
  "sender":{
      "_id":"593807c13b3132a1e27c8069",
      "type":"user",
      "username":"wesleyf@esna.com",
      "displayname":"Wesley Frederickson",
      "picture_url":"https://accounts.zang.io/norevimages/noimage.jpg"
  },
  "created":"2017-07-20T13:49:42.408Z",
  "category":"video.screensharedata",
  "content":{
      "image":"https://storage.googleapis.com/onesna/logan%2Fscreen_59665be02c305405b327c2d7%2F1?GoogleAccessId=logan-gcs@onesna-all.esna.com.iam.gserviceaccount.com&Expires=1500564280&Signature=a%2BJ3FDlp1noxBHtlPkSjGnVXSSxVNNifqmDJc8P8BPnNVzbQgITB0FKl7v5wDbWiel2Krpija5P3DcJerQE%2Fn3sgViIrNY0lU8RYCGN2Ap5KecJ%2BVO3wOCrLwk9tvzNc8%2FN%2BTHpZh1gHNZkC7YHI5Z1RS1okdd5sN6RaMMKD8DKi3298oCyw7R8VFYzfEIaBMnWEpPFSqXBoZ5wTHi0uGh4uCvR27E%2Bhkv1RSXrYLJn9F2kgjR5%2BX%2BTKZyjEr5rHODHUhZX8Qu1ieyzo786fO4BioCXuTC6Nd74dd8UaH4z2PuCQ%2FjhaPH7aBOC3%2BLjtbVrFWBNevgmL1LRdhcV6hQ%3D%3D&scrtm=1500558582408",
      "timeUploaded":1500558581852,
      "width":1920,
      "height":1080,
      "sessionId":"8c3b5ea1-2250-4226-ffcd-d6df6cddfe44"
  }
}

Payload ('video.stopscreenshare')

{
  "topicId":"59665be02c305405b327c2d7",
  "sender":{
      "_id":"593807c13b3132a1e27c8069",
      "type":"user",
      "username":"wesleyf@esna.com",
      "displayname":"Wesley Frederickson",
      "picture_url":"https://accounts.zang.io/norevimages/noimage.jpg"
  },
  "content":{
      "streamId":"TndeYt1yiXxDJHwDz2I2icDvJLY5O6xmWxbN",
      "sessionId":"8c3b5ea1-2250-4226-ffcd-d6df6cddfe44"
  },
  "created":"2017-07-20T13:49:43.922Z",
  "category":"video.stopscreenshare"
}