Viewer API

Viewer Toolbox

RayV Embedded Plug-In Scripting API

Properties
Property Value Access Default Value Description
ChannelID String Read/Write n/a RayV Channel which will be delivered.
FullScreenState Bool Read/Write False Expands the area of the playback panel to fill the entire screen. Also get back to normal screen viewing.
SessionActive Bool Read/Write True Starts/stops a channel playback. Could be used as a static parameter of the control to initiate the playback once the page is loaded.
Volume integer (0..100) Read/Write 25 Current Volume Level (for control) – changing this value does not affect MuteState
MuteState Bool Read/Write False Sets or retrieves a value indicating the current mute state of the control.
ChannelInfo XMLText Read-only n/a Retrieves structured data about the current Channel - This data is created automatically by RayV based on the information provided by the affiliate when setting the channels in RayV database.


Methods / Functions
Method Return Type Parameters/Notes
ResetUI Void Removes the Volume, Info & Settings buttons from the bottom bar and the error messages from the viewer window.
DoViewerHelp Void Shows the 'Tech Support' dialog box.


Events
Event Event Data/Notes
rayv_onPlayStateChanged
  • SESSION_INACTIVE - Session is not active
  • SESSION_SIGNINGIN - Viewer is not signed in to the server (but might be in the process of sign in)
  • SESSION_JOINING - Viewer is not joined to the channel (but might be in the process of joining)
  • SESSION_CONTACTING - Joined channel and contacting peers
  • SESSION_BUFFERING - Getting data from peers but not enough data for playing
  • SESSION_WAITINGIFRAME - Playing audio not video since didn't receive first I-frame (keyframe)
  • SESSION_PLAYING - Playing channel audio and video
rayv_onApplicationExit Is invoked when the user closes the main RayV Viewer application.


RayV Installer Properties

The following table contains a full list of Properties supported by the RayV Embedded Viewer Installer.

Events Description Format Default Value
AffiliateID Setup owner String, lower case, alphanumeric RayV
Language Setup language String, 2 letters from ISO 639-1 en
InstallBGColorStart Gradient background color to use for the Web setup String, 6 digits hex, RGB 6997bb
InstallBGColorEnd 6087ae