Click or drag to resize

StreamControl Class

Control for streaming.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DMStreamControl

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class StreamControl

The StreamControl type exposes the following members.

Properties
 NameDescription
Public propertyElapsedSecondsFeedback Indicates the time elapsed (in seconds) since streaming was started.

The DMInputChange event will trigger with ElapsedSecEventId.

Public propertyInitiatorAddressFeedback Property to return the Initiator or Device Address which DMPS3-4K-250/350C Dmps3AirMediaInput is connected to when SessionInitiation is in ByTransmitter mode.

The DMInputChange event will trigger with InitiatorAddressEventId.

Public propertyMulticastAddress Specifies the multicast address to which DMPS3-4K-250/350C Dmps3AirMediaInput will try to stream if SessionInitiation is in MulticastViaRTSP mode or in MulticastViaUDP mode.
Public propertyMulticastAddressFeedback Indicates the multicast address to which the card is streaming if SessionInitiation is in MulticastViaRTSP mode or in in MulticastViaUDP mode.

The DMInputChange event will trigger with MulticastAddressEventId.

Public propertyPassword Sets the password for the stream. The password can consist of up to 200 characters.
Public propertyPasswordFeedback Text string that reports the password used for the stream.

The DMInputChange event will trigger with PasswordEventId.

Public propertyPauseFeedback Indicates that the stream is paused. The output remains 'true' for as long as the stream is paused.

The DMInputChange event will trigger with PauseEventId.

Public propertyProcessingFeedback Property to indicate the processing status. 'true = Processing in progress; 'false' = Processing not in progress.

The DMInputChange event will trigger with ProcessingEventId.

Public propertyRtpAudioPort Property to set the RTP Audio Port.
Public propertyRtpAudioPortFeedback Property to report the current RTP Audio Port.

The DMInputChange event will trigger with RtpAudioPortEventId.

Public propertyRtpVideoPort Property to set the RTP Video Port.
Public propertyRtpVideoPortFeedback Property to report the current RTP Video Port.

The DMInputChange event will trigger with RtpVideoPortEventId.

Public propertyRtspPort Property to set the RTSP Port.
Public propertyRtspPortFeedback Property to report the current RTSP Port.

The DMInputChange event will trigger with RtspPortEventId.

Public propertyServerUrl Property to set the Server URL. This is the full path of the server Url to which the stream receiver should connect when SessionInitiation is in ByReceiver mode or in MulticastViaRTSP mode.
Public propertyServerUrlFeedback Property to return the Server URL when streaming out video.

The DMInputChange event will trigger with ServerUrlEventId.

Public propertySessionInitiation Specifies the session initiation status
Public propertySessionInitiationFeedback Reports the current session initiation status

The DMInputChange event will trigger with SessionInitiationEventId.

Public propertyStartFeedback Indicates if streaming has started. 'true' = Streaming started; 'false' = Streaming has not started.

The DMInputChange event will trigger with StartEventId.

Public propertyStatisticsDisableFeedback Property to indicate statistics are disabled.

The DMInputChange event will trigger with StatisticsDisableEventId.

Public propertyStatisticsEnableFeedback Property to indicate statistics are enabled.

The DMInputChange event will trigger with StatisticsEnableEventId.

Public propertyStatisticsNumberOfAudioPacketsDroppedFeedback Property to report the Number of Audio Packets Dropped.

The DMInputChange event will trigger with StatisticsNumberOfAudioPacketsDroppedEventId.

Public propertyStatisticsNumberOfAudioPacketsReceivedFeedback Property to report the Number of Audio Packets Received.

The DMInputChange event will trigger with StatisticsNumberOfAudioPacketsReceivedEventId.

Public propertyStatisticsNumberOfVideoPacketsDroppedFeedback Property to report the Number of Video Packets Dropped.

The DMInputChange event will trigger with StatisticsNumberOfVideoPacketsDroppedEventId.

Public propertyStatisticsNumberOfVideoPacketsReceivedFeedback Property to report the Number of Video Packets Received.

The DMInputChange event will trigger with StatisticsNumberOfVideoPacketsReceivedEventId.

Public propertyStatusTextFeedback Property to return the status in text. e.g. "Stream stopped","Stream paused", or "Connecting".

The DMInputChange event will trigger with StatusTextEventId.

Public propertyStopFeedback Indicates the stream status. 'true' = Stream stopped; 'false' = Stream not stopped.

The DMInputChange event will trigger with StopEventId.

Public propertyStreamingBuffer Property to set the amount of Video to be cached in milliseconds. Valid values are from 0 to 5000.
Public propertyStreamingBufferFeedback Property to report the amount of Video cached in milliseconds.

The DMInputChange event will trigger with StreamingBufferEventId.

Public propertyStreamingTransportMode Property to set the Streaming Transport Mode.
Public propertyStreamingTransportModeFeedback Property to report the current Streaming Transport Mode.

The DMInputChange event will trigger with StreamingTransportModeEventId.

Public propertyStreamStatusFeedback Property to report the streaming status. Value ranges from 0 to 65535, where 0 = "Stream stopped", 1 = "Stream started", 2 = "Stream paused", 3 = "Connecting". Other values are reserved for future status states.

The DMInputChangeevent will trigger with StreamStatusEventId.

Public propertyTsPort Property to set the UDP Port at which both video and audio are received or transmitted.
Public propertyTsPortFeedback Property to report the current UDP Port at which both video and audio are received or transmitted.

The DMInputChange event will trigger with TsPortEventId.

Public propertyUserName Specifies the user name for the stream. The user name can consist of up to 200 characters.
Public propertyUserNameFeedback Text string that reports the user name used for the stream.

The DMInputChange event will trigger with UserNameEventId.

Public propertyVolume Sets the source volume.
Public propertyVolumeFeedback Reports the source volume level.

The DMInputChange event will trigger with VolumeEventId.

Top
Methods
 NameDescription
Public methodDisableStatistics Method to disable statistics.
Public methodEnableStatistics Method to enable statistics.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodPause Pauses the stream of the input. Note: although the incoming video to the encoder is paused (frozen), the stream will continue playing and the elapsed time counter will continue in the paused state. This allows a freeze frame to be displayed if the user does not want live video to be transmitted.
Public methodResetStatistics Method to reset statistics.
Public methodStart Starts streaming of the input.
Public methodStop Stops streaming of the input.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also