Click or drag to resize

CaptureHdBase Properties

The CaptureHdBase type exposes the following members.

Properties
 NameDescription
Public propertyAverageBitrateFeedback Property to report the Average bit rate of the streaming device.

The BaseEvent event will trigger with AverageBitrateReceivedEventId.

Public propertyBackgroundPicture Property to select the video source that will be designated as the background picture.
Public propertyBackgroundPictureFeedback Property to report which input is the background picture.

The BaseEvent event will trigger with BackgroundPictureVideoSourceReceivedEventId.

Public propertyBass Property to set the bass level at the analog audio output (AUDIO OUT).
Public propertyBassFeedback Property to report the bass level at AUDIO OUT.

The BaseEvent event will trigger with BassLevelReceivedEventId.

Public propertyBookmarkFeedback Property to track the state of the corresponding Bookmark input.

The BaseEvent event will trigger with BookmarkReceivedEventId.

Public propertyCameraCompositeDetectedFeedback Property to indicate that the video source selected by ContentVideoInput Sig is detected at CONTENT IN.

The BaseEvent event will trigger with CameraCompositeDetectedEventId.

Public propertyCaptureBitrate Property to set the bit rate of the capture video in KB/s.
Public propertyCaptureBitrateFeedback Property to report the bit rate of the capture video.

The BaseEvent event will trigger with CaptureVideoBitrateReceivedEventId.

Public propertyCaptureFileFormat Property to set the type of file container used for the capture's video files.
Public propertyCaptureFileFormatFeedback Property to report the container type of the capture video.

The BaseEvent event will trigger with CaptureVideoFileFormatReceivedEventId.

Public propertyCaptureVideoFormat Property to set the resolution of the capture's video.
Public propertyCaptureVideoFormatFeedback Property to report the resolution of the capture video.

The BaseEvent event will trigger with CaptureVideoFormatReceivedEventId.

Public propertyClientUrl Property to specify the Client URL of the streaming device.
Public propertyClientUrlFeedback Property to report Client URL of the streaming device.

The BaseEvent event will trigger with ClientUrlReceivedEventId.

Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyContentAudioDelay Property to set the delay for the CONTENT IN audio source.
Public propertyContentAudioDelayFeedback Property to report the CONTENT IN audio delay.

The BaseEvent event will trigger with ContentAudioDelayReceivedEventId.

Public propertyContentAudioInput Property to set the content in audio source.
Public propertyContentAudioInputFeedback Property to report the current content in audio source.

The BaseEvent event will trigger with ContentAudioInputReceivedEventId.

Public propertyContentAudioInputSelectionFeedback Property to report the audio input being selected by ContentAudioInput Sig.

The BaseEvent event will trigger with ContentAudioInputSelectionReceivedEventId.

Public propertyContentBass Property to set the bass level for the content audio input.
Public propertyContentBassFeedback Property to report the bass level for the content audio input.

The BaseEvent event will trigger with ContentBassLevelReceivedEventId.

Public propertyContentHdmiInputCompensation Property to set the input gain compensation at the content HDMI audio input.
Public propertyContentHdmiInputCompensationFeedback Property to report the input gain compensation at the content HDMI audio input.

The BaseEvent event will trigger with ContentHdmiInputCompensationReceivedEventId.

Public propertyContentInputCompensation Property to set the input gain compensation at the content audio input.
Public propertyContentInputCompensationFeedback Property to report the input gain compensation at the content audio input.

The BaseEvent event will trigger with ContentInputCompensationReceivedEventId.

Public propertyContentMixingLevel Property to set the mixing level for the audio input.
Public propertyContentMixingLevelFeedback Property to report the mixing level for the content audio input.

The BaseEvent event will trigger with ContentMixingLevelReceivedEventId.

Public propertyContentTreble Property to set the treble level for the content audio input.
Public propertyContentTrebleFeedback Property to report the treble level for the content audio input.

The BaseEvent event will trigger with ContentTrebleLevelReceivedEventId.

Public propertyContentVideoDetectedFeedback Property to recall the Full frame foreground over background PIP (Picture in Picture) view.

The BaseEvent event will trigger with ContentVideoDetectedEventId.

Public propertyContentVideoInfoFeedback Property to provide information about the video source at CONTENT IN.

The BaseEvent event will trigger with ContentVideoSourceInformationReceivedEventId.

Public propertyContentVideoInput Property to select the video input type at the CONTENT IN input.
Public propertyContentVideoInputFeedback Property to report the currently selected video type at CONTENT IN.

The BaseEvent event will trigger with SelectedContentVideoInputReceivedEventId.

Public propertyContentVideoInputSelectionFeedback Property to report the video input being selected by ContentVideoInput Sig.

The BaseEvent event will trigger with ContentVideoInputSelectionReceivedEventId.

Public propertyContentVuFeedback Property to report the VU meter feedback value, only when VU feedback is enabled (via the top level CAPTURE-HD(PRO) slot).

The BaseEvent event will trigger with ContentVuFeedbackReceivedEventId.

Public propertyCurrentMeetingNameFeedback Property to keep the title of the current meeting as specified in RoomView.

The BaseEvent event will trigger with CurrentMeetingNameReceivedEventId.

Public propertyCurrentMeetingOrganizerFeedback Property to keep the name of the organizer of the current meeting, as specified in RoomView.

The BaseEvent event will trigger with CurrentMeetingOrganizerNameReceivedEventId.

Public propertyCurrentMeetingTimeFeedback Property to keep the time and date of the current meeting, as specified in RoomView.

The BaseEvent event will trigger with CurrentMeetingTimeReceivedEventId.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisableElapsedSeconds Property to disable the ElapsedSecondsFeedback Sig from reporting the elapsed seconds.
Public propertyDisableElapsedSecondsFeedback Property to indicate that elapsed seconds reporting is disabled.

The BaseEvent event will trigger with ElapsedSecondsReportingDisabledEventId.

Public propertyDisableUploadsFeedback Property to indicate that Disable upload files to server action is received.

The BaseEvent event will trigger with DisableUploadsReceivedEventId.

Public propertyDisableVuFeedback Property to disable VU feedback on the Audio slot.
Public propertyDisableVuFeedbackFeedback Property to indicate that VU feedback is disabled.

The BaseEvent event will trigger with VuFeedbackDisabledEventId.

Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyElapsedSecondsFeedback Property to report the elapsed seconds of the current meeting, only when reporting is enabled.

The BaseEvent event will trigger with ElapsedSecondsReceivedEventId.

Public propertyEnableUploadsFeedback Property to indicate that Enable upload files to server action is received.

The BaseEvent event will trigger with EnableUploadsReceivedEventId.

Public propertyFileNamePrefix Property to set the file name of the recording, used in place of the default hostname.
Public propertyFileNamePrefixFeedback Property to keep the current filename prefix.

The BaseEvent event will trigger with FileNamePrefixReceivedEventId.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyMaxUploadRetries Property to specify the number of times capture device will try to upload to the server.
Public propertyMaxUploadRetriesFeedback Property to report the Maximum no of upload retries received.

The BaseEvent event will trigger with MaxUploadsRetriesReceivedEventId.

Public propertyMmcDetectedFeedback Property to indicate that the video type detected at CAMERA IN is SDI.

The BaseEvent event will trigger with MmcDetectedEventId.

Public propertyMmcSpaceAvailableFeedback Property to report the available disc space of the MMC storage device in megabytes.

The BaseEvent event will trigger with MmcSpaceAvailableReceivedEventId.

Public propertyMmcSpaceLowFeedback Property to indicate that the MMC storage device is running below 20% of remaining disc space.

The BaseEvent event will trigger with MmcSpaceLowReceivedEventId.

Public propertyMmcSpaceTotalFeedback Property to report the total disc space of the MMC storage device in megabytes.

The BaseEvent event will trigger with MmcSpaceTotalReceivedEventId.

Public propertyMmcSpaceUsedFeedback Property to report the used disc space of the MMC storage device in megabytes.

The BaseEvent event will trigger with MmcSpaceUsedReceivedEventId.

Public propertyMmcTimeLeftFeedback Property to report the recording time remaining on the MMC storage device in minutes.

The BaseEvent event will trigger with MmcTimeLeftReceivedEventId.

Public propertyMulticastAddress Property to specify the Multicast address of the streaming device.
Public propertyMulticastAddressFeedback Property to report Multicast Address of the streaming device.

The BaseEvent event will trigger with MulticastAddressReceivedEventId.

Public propertyMute Property to mute the analog audio output (AUDIO OUT).
Public propertyMuteFeedback Property to indicate that the mute function at AUDIO OUT is active.

The BaseEvent event will trigger with MuteActiveEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNextMeetingNameFeedback Property to keep the title of the next meeting as specified in RoomView.

The BaseEvent event will trigger with NextMeetingNameReceivedEventId.

Public propertyNextMeetingOrganizerFeedback Property to keep the name of the organizer of the next meeting, as specified in RoomView.

The BaseEvent event will trigger with NextMeetingOrganizerNameReceivedEventId.

Public propertyNextMeetingTimeFeedback Property to keep the time and date of the next meeting, as specified in RoomView.

The BaseEvent event will trigger with NextMeetingTimeReceivedEventId.

Public propertyOperationalMode Property to set the operational mode of the device.
Public propertyOperationalModeFeedback Property to report the operational mode of the device.

The BaseEvent event will trigger with OperationalModeReceivedEventId.

Public propertyOutputMode Property to set the display mode at HDMI out.
Public propertyOutputModeFeedback Property to report the currently selected display mode at HDMI OUT.

The BaseEvent event will trigger with OutputModeReceivedEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPauseFeedback Property to indicate that recording has been paused.

The BaseEvent event will trigger with PauseActiveEventId.

Public propertyPipSize Property to set the size of the PIP window.
Public propertyPipSizeFeedback Property to report the size of the PIP window.

The BaseEvent event will trigger with PipSizeReceivedEventId.

Public propertyRecallPipFullFrame Property to recall the Full frame foreground over background PIP (Picture in Picture) view.
Public propertyRecallPipFullFrameFeedback Property to indicate that the Full frame foreground over background PIP view is active.

The BaseEvent event will trigger with PipFullFrameViewRecalledEventId.

Public propertyRecallPipLowerLeft Property to recall the lower left PIP (Picture in Picture) view.
Public propertyRecallPipLowerLeftFeedback Property to indicate that the lower left PIP view is active.

The BaseEvent event will trigger with PipLowerLeftViewRecalledEventId.

Public propertyRecallPipLowerRight Property to recall the lower right PIP (Picture in Picture) view.
Public propertyRecallPipLowerRightFeedback Property to indicate that the lower right PIP view is active.

The BaseEvent event will trigger with PipLowerRightViewRecalledEventId.

Public propertyRecallPipSideBySide Property to recall the CAMERA and CONTENT side by side PIP (Picture in Picture) view.
Public propertyRecallPipSideBySideFeedback Property to indicate that the video source selected by ContentVideoInput Sig is detected at CONTENT IN.

The BaseEvent event will trigger with PipSideBySideViewRecalledEventId.

Public propertyRecallPipUpperLeft Property to recall the upper left PIP (Picture in Picture) view.
Public propertyRecallPipUpperLeftFeedback Property to indicate that the upper left PIP view is active.

The BaseEvent event will trigger with PipUpperLeftViewRecalledEventId.

Public propertyRecallPipUpperRight Property to recall the upper Right PIP (Picture in Picture) view.
Public propertyRecallPipUpperRightFeedback Property to indicate that the upper right PIP view is active.

The BaseEvent event will trigger with PipUpperRightViewRecalledEventId.

Public propertyRecordMode Property to set the record mode to Normal when false, and Ad Hoc when true.
Public propertyRecordModeFeedback Property to indicate the active record mode. When true, this indicates Ad Hoc mode; when false, Normal mode.

The BaseEvent event will trigger with RecordModeReceivedEventId.

Public propertyRecordStateFeedback Property to select the method of time clock synchronization for the capture device.

The BaseEvent event will trigger with RecordStateReceivedEventId.

Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertySessionInitiation Property to set the Session initiation value of the Streaming device.
Public propertySessionInitiationFeedback Property to report the Session initiation of the streaming device.

The BaseEvent event will trigger with SessionInitiationReceivedEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySourceCvbsAspectRatioFeedback Property to report Aspect ratio of CVBS source.

The BaseEvent event will trigger with SourceCvbsAspectRatioReceivedEventId.

Public propertySourceCvbsFramesPerSecondFeedback Property to report frames per second of CVBS source.

The BaseEvent event will trigger with SourceCvbsFramesPerSecondReceivedEventId.

Public propertySourceCvbsHorizontalResolutionFeedback Property to report Horizontal resolution of CVBS source.

The BaseEvent event will trigger with SourceCvbsHorizontalResolutionReceivedEventId.

Public propertySourceCvbsVerticalResolutionFeedback Property to report Vertical resolution of CVBS source.

The BaseEvent event will trigger with SourceCvbsVerticalResolutionReceivedEventId.

Public propertySourceHdmiAspectRatioFeedback Property to report Aspect ratio of HDMI source.

The BaseEvent event will trigger with SourceHdmiAspectRatioReceivedEventId.

Public propertySourceHdmiFramesPerSecondFeedback Property to report frames per second of HDMI source.

The BaseEvent event will trigger with SourceHdmiFramesPerSecondReceivedEventId.

Public propertySourceHdmiHorizontalResolutionFeedback Property to report Horizontal resolution of HDMI source.

The BaseEvent event will trigger with SourceHdmiHorizontalResolutionReceivedEventId.

Public propertySourceHdmiVerticalResolutionFeedback Property to report Vertical resolution of HDMI source.

The BaseEvent event will trigger with SourceHdmiVerticalResolutionReceivedEventId.

Public propertySourceVgaAspectRatioFeedback Property to report Aspect ratio of VGA source.

The BaseEvent event will trigger with SourceVgaAspectRatioReceivedEventId.

Public propertySourceVgaFramesPerSecondFeedback Property to report frames per second of VGA source.

The BaseEvent event will trigger with SourceVgaFramesPerSecondReceivedEventId.

Public propertySourceVgaHorizontalResolutionFeedback Property to report Horizontal resolution of VGA source.

The BaseEvent event will trigger with SourceVgaHorizontalResolutionReceivedEventId.

Public propertySourceVgaVerticalResolutionFeedback Property to report Vertical resolution of VGA source.

The BaseEvent event will trigger with SourceVgaVerticalResolutionReceivedEventId.

Public propertySpeechBass Property to set the bass level for the speech audio input.
Public propertySpeechBassFeedback Property to report the bass level for the speech audio input.

The BaseEvent event will trigger with SpeechBassLevelReceivedEventId.

Public propertySpeechInputCompensation Property to set the input gain compensation at the speech audio input.
Public propertySpeechInputCompensationFeedback Property to report the input gain compensation at the speech audio input.

The BaseEvent event will trigger with SpeechInputCompensationReceivedEventId.

Public propertySpeechMixingLevel Property to set the mixing level for the speech audio input.
Public propertySpeechMixingLevelFeedback Property to report the mixing level for the speech audio input.

The BaseEvent event will trigger with SpeechMixingLevelReceivedEventId.

Public propertySpeechTreble Property to set the treble level for the speech audio input.
Public propertySpeechTrebleFeedback Property to report the treble level for the speech audio input.

The BaseEvent event will trigger with SpeechTrebleLevelReceivedEventId.

Public propertySpeechVuFeedback Property to report the VU meter feedback value, only when VU feedback is enabled (via the top level CAPTURE-HD(PRO) slot).

The BaseEvent event will trigger with SpeechVuFeedbackReceivedEventId.

Public propertyStartFeedback Property to indicate that the function specified by Operational Mode is active.

The BaseEvent event will trigger with StartActiveEventId.

Public propertyStatusDescriptionFeedback Property to report status, errors and progress indications to the user.

The BaseEvent event will trigger with UploadStatusDescriptionReceivedEventId.

Public propertyStopFeedback Property to indicate that recording has stopped.

The BaseEvent event will trigger with StopActiveEventId.

Public propertyStorageDefaultLocation Property to set the default storage location for capture video files.
Public propertyStorageDefaultLocationFeedback Property to report the default storage location for capture video files.

The BaseEvent event will trigger with StorageDefaultLocationReceivedEventId.

Public propertyStreamingBitrate Property to set the maximum bit rate of the video stream.
Public propertyStreamingBitrateFeedback Property to report the current bit rate.

The BaseEvent event will trigger with StreamingBitrateReceivedEventId.

Public propertyStreamingFeedback Property to indicate that the RTSP unicast stream is currently streaming.

The BaseEvent event will trigger with StreamingActiveEventId.

Public propertyStreamingFormat Property to set the format (resolution) of the RTSP unicast video stream.
Public propertyStreamingFormatFeedback Property to report the currently selected transmit stream resolution.

The BaseEvent event will trigger with StreamingFormatReceivedEventId.

Public propertyStreamingProfile Property to set the video stream profile.
Public propertyStreamingProfileFeedback Property to report the currently selected profile.

The BaseEvent event will trigger with StreamingProfileReceivedEventId.

Public propertyStreamingUrlFeedback Property to report the URL of the video stream.

The BaseEvent event will trigger with StreamingUrlReceivedEventId.

Public propertyTargetAddress Property to specify the Target address of the streaming device.
Public propertyTargetAddressFeedback Property to report Target Address of the streaming device.

The BaseEvent event will trigger with TargetAddressReceivedEventId.

Public propertyTimeSyncMethod Property to select the method of time clock synchronization for the capture device.
Public propertyTimeSyncMethodFeedback Property to report the currently selected time sync method.

The BaseEvent event will trigger with TimeSyncMethodReceivedEventId.

Public propertyTreble Property to set the treble level at the analog audio output (AUDIO OUT).
Public propertyTrebleFeedback Property to report the treble level at AUDIO OUT.

The BaseEvent event will trigger with TrebleLevelReceivedEventId.

Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUploadInProgressFeedback Property to indicate that the capture device is uploading a file to a hosting service or other location.

The BaseEvent event will trigger with UploadInProgressReceivedEventId.

Public propertyUploadPassword1 Property to set the password for logging into the account of the destination where the capture file will be uploaded.
Public propertyUploadPath1 Property to keep the full file path of the destination where the capture file will be uploaded.
Public propertyUploadPath1Feedback Property to report the file path of the upload destination.

The BaseEvent event will trigger with UploadPath1ReceivedEventId.

Public propertyUploadStateFeedback Property to report the upload state.

The BaseEvent event will trigger with UploadStateReceivedEventId.

Public propertyUploadUserName1 Property to set the user name for logging into the account of the destination where the capture file will be uploaded.
Public propertyUploadUserName1Feedback Property to report the user name.

The BaseEvent event will trigger with UploadUserName1ReceivedEventId.

Public propertyUsb1DetectedFeedback Property to indicate that a storage device is detected at the Front panel USB port.

The BaseEvent event will trigger with Usb1DetectedEventId.

Public propertyUsb1SpaceAvailableFeedback Property to report the available disc space of the Front panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb1SpaceAvailableReceivedEventId.

Public propertyUsb1SpaceLowFeedback Property to indicate that the Front panel USB storage device is running below 20% of remaining disc space.

The BaseEvent event will trigger with Usb1SpaceLowReceivedEventId.

Public propertyUsb1SpaceTotalFeedback Property to report the total disc space of the Front panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb1SpaceTotalReceivedEventId.

Public propertyUsb1SpaceUsedFeedback Property to report the used disc space of the Front panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb1SpaceUsedReceivedEventId.

Public propertyUsb1TimeLeftFeedback Property to report the recording time remaining on the Front panel USB storage device in minutes.

The BaseEvent event will trigger with Usb1TimeLeftReceivedEventId.

Public propertyUsb2DetectedFeedback Property to indicate that a storage device is detected at the Back panel USB port.

The BaseEvent event will trigger with Usb2DetectedEventId.

Public propertyUsb2SpaceAvailableFeedback Property to report the available disc space of the Back panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb2SpaceAvailableReceivedEventId.

Public propertyUsb2SpaceLowFeedback Property to indicate that the Back panel USB storage device is running below 20% of remaining disc space.

The BaseEvent event will trigger with Usb2SpaceLowReceivedEventId.

Public propertyUsb2SpaceTotalFeedback Property to report the total disc space of the Back panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb2SpaceTotalReceivedEventId.

Public propertyUsb2SpaceUsedFeedback Property to report the used disc space of the Back panel USB storage device in megabytes.

The BaseEvent event will trigger with Usb2SpaceUsedReceivedEventId.

Public propertyUsb2TimeLeftFeedback Property to report the recording time remaining on the Back panel USB storage device in minutes.

The BaseEvent event will trigger with Usb2TimeLeftReceivedEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyVolume Property to set the volume level at the analog audio output (AUDIO OUT).
Public propertyVolumeFeedback Property to report the volume level at AUDIO OUT.

The BaseEvent event will trigger with VolumeLevelReceivedEventId.

Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
See Also