G-8
Cisco Interactive Experience Client 4600 Series User Guide
Appendix G Stream Live Video
Stream Live Video
global.videoEncoder object Variables
Table G-3
global.videoEncoder Object Variables
Variable
Description
isAvailable
Use this routine to check if the box has
videoEncoder Module in it. A ‘true’ value
indicates presence of the module.
status
Represents status of video encoder. The status are
listed in the section below as enumeration for your
reference.
errorCode
This attribute will be set when an error occurs.
Use this attribute for error handling in your
application.
errorMessage
This routine returns the error string corresponding
to the errorCode that was set. Use this function to
display an error message to the user in your
application.
videoInputCount
Returns the available video sources including the
HDMI input from the USB dongle and all
available webcams.
videoInputDescription
Returns the description of all video input devices
present in the box.
targetHost
Returns the target host to which the encoded
stream is being sent.
targetPort
Returns the port number on which the encoded
stream is being sent.
protocol
Returns integer value for the Transport Protocol:
‘0’ for UDP or ‘1’ for TCP.
videoMode
Returns video mode on which the video encoder is
operating. Values are: ‘0’ - SD, ‘1’ - HD, and ‘2’
for Custom.
videoSource
Returns the video source being selected for
encoding either as ‘0’ for HDMI or ‘1’ for
videoInputCount for webcam.
h264Profile
Returns the encoding H.264 profile being used by
the encoder: ‘0’ for Baseline, ‘1’ for Main, and ‘2’
for Extended Profile.
inputResolution
Returns the input resolution that is being used for
the source. Possible values are ‘0’ for 1920x1080
resolution, ‘1’ for 1280x720, and ‘2’ for
1024x600.
isProgressive
Returns ‘true’ if the scan format is set to
Progressive.