Definitions
The following parameters are used as part of the Guest Login process:
- guestName
- roomKey
- Portal Access Key (PAK)
PAK is provided as part of login response by VidyoPortal - EndpointID (EID)
A unique identifier representing an Endpoint
This is provided by the VidyoDesktop - guestID
A unique identifier representing a Guest within the VidyoPortal
This is provided as part of login response by VidyoPortal
The following steps describe the sequence of events in the Guest Login process:
- SOAP-Request from Application to VidyoPortal
LogInAsGuest (roomKey, guestName) - SOAP-Response from VidyoPortal to Application
LogInAsGuest (PAK) - For WS Application only:
- HTTP-Request from Application to VidyoDesktop on 127.0.0.1:63457 with the following parameters
- Redirect URL (URL): The VidyoDesktop provides response using a HTTP redirect. The application provides this Redirect URL and processes the information to retrieve the response parameters.
- VidyoManager (vm) address
- VidyoPortal (portal) service address
- VidyoProxy (proxy) address
- UN (UN):Temporary Username
- PAK (PAK): Portal Access Key
- e.g.
http://127.0.0.1:63457/dummy?url=http://dev20.vidyo.com/linkendpoint.ajax?vm=PVCVG7NXUC5YER8FCXBC1ZD88NK6PQ7VYR2918XAXRQA600VM0001@dev20.vidyo.com:17992;transport=TCP&un=XpMgcsgdEl5z5vT8&pak=9YprUdCg8gPKpr5H&proxy=64.71.164.195:443&portal=http://main.vidyo.com/services/&loctag=Default_Location
- HTTP-Redirect from VidyoDesktop to Application
- EID
- VidyoDesktop version
- HTTP-Request from Application to VidyoDesktop on 127.0.0.1:63457 with the following parameters
- For Custom Client and WS Application(unified client):
If you’re not developing a custom client using the VidyoClient Library please skip this section and go to step 4. The following steps are required usage of VidyoClient library.
- Client API: Send VIDYO_CLIENT_IN_EVENT_SIGN_IN (LogInAsGuest response params)
- Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN.
- Check param.activeEid field to see if the EID is already set up
- Client API: Send VIDYO_CLIENT_IN_EVENT_LICENSE
- Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LICENSE
- Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGN_IN Returns activeEID (which should be active at this point-equal 1)
- Client API: Send VIDYO_CLIENT_REQUEST_GET_EID Returns EID string.
- WS GuestAPI: LinkEndpointToGuest (guestID, EID)
- LinkEndpointToGuest (OK)
- LinkEndpointToGuest (OK)
- Client API: Wait for VIDYO_CLIENT_OUT_EVENT_LINKED
- Client API: Wait for VIDYO_CLIENT_OUT_EVENT_SIGNED_IN
Process complete. Wait a few seconds before joining the conference. - SOAP-Request from Application to VidyoPortal
- GuestJoinConference(guestID, pin)
- GuestJoinConference(guestID, pin)
- Client API: Send VIDYO_CLIENT_IN_EVENT_SIGN_IN (LogInAsGuest response params)
- SOAP-Request from Application to VidyoPortal
- LinkEndpointToGuest (guestID, EID)
- LinkEndpointToGuest (guestID, EID)
- SOAP-Response from VidyoPortal to Application
- LinkEndpointToGuest (OK)
- LinkEndpointToGuest (OK)
- SOAP-Request from Application to VidyoPortal
- GuestJoinConference(guestID, pin)
Comments
0 comments
Please sign in to leave a comment.