Detailed Description

A MediaStream is a Stream class that provides additional methods and properties specific to the Media Stream.

The media stream can contain Video, Audio and metadata.

See also: Stream

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0

#include <MediaStream.h>

Public Member Functions
DB_EDGEVIS_SDK void	RequestKeyFrame ()
	Request that the encoder inserts a key frame in to the EdgeVis stream.

DB_EDGEVIS_SDK void	SetEnableSCTData (bool enable)
	Enables the SCTData callback on the listener. More...

DB_EDGEVIS_SDK bool	GetEnableSCTData ()
	Returns if the SCTData callbacks are enabled. More...

DB_EDGEVIS_SDK void	SetEnableIndexedSCTData (bool enable)
	Enables the SCTIndexedData callback on the listener. More...

DB_EDGEVIS_SDK bool	GetEnableIndexedSCTData ()
	Returns true if the SCTIndexedData is enabled. More...

DB_EDGEVIS_SDK void	SetEnableAudioData (bool enable)
	Enables the Audio data callback on the listener. More...

DB_EDGEVIS_SDK bool	GetEnableAudioData ()
	Returns true if the audio callbacks are enabled. More...

DB_EDGEVIS_SDK void	GetLastFrame (YCbCrFrame &destination)
	Returns the last frame of video as a YCbCrFrame. More...

DB_EDGEVIS_SDK void	EnableFullResBuffer (int32_t fullResBufferSize, int32_t memoryQuota, int32_t fullResFps, int32_t KeepInflated)
	Enables the full resolution feature on the encoder. More...

DB_EDGEVIS_SDK void	DisableFullResBuffer ()
	Enables the full resolution feature on the encoder. More...

DB_EDGEVIS_SDK void	SetFullResJPEGQuality (int32_t quality)
	Sets the quality of the JPEG frame as cached locally. More...

DB_EDGEVIS_SDK int32_t	GetFullResJPEGQuality ()
	Returns the value of the JPEG frame as cached locally. More...

DB_EDGEVIS_SDK void	SetFullResMaxInflatedFrames (int32_t maxInflatedFrames)
	Sets the maximum number of frames to keep inflated. More...

DB_EDGEVIS_SDK int32_t	GetFullResMaxInflatedFrames ()
	Returns the maximum number of frames to keep inflated. More...

DB_EDGEVIS_SDK void	SetFullResFps (int32_t fps)
	Sets the maximum number for fps for the full resolution cache. More...

DB_EDGEVIS_SDK int32_t	GetFullResFps ()
	Returns the maximum number for fps for the full resolution cache. More...

DB_EDGEVIS_SDK void	SetFullResMaxCachedFrames (int32_t maxCachedFrames)
	Sets the maximum number of frames to cache for the Full Resolution feature. More...

DB_EDGEVIS_SDK int32_t	GetFullResMaxCachedFrames ()
	Returns the maximum number of frames being cached for the Full Resolution feature. More...

DB_EDGEVIS_SDK int32_t	GetStreamBandwidth ()
	Returns the current bandwidth of the media stream in bits per second. More...

DB_EDGEVIS_SDK double	GetFrameRate ()
	Returns the current frames per second of the decoded video stream. More...

DB_EDGEVIS_SDK int32_t	GetFrameHeight ()
	Returns the current height of frames of the decoded video stream. More...

DB_EDGEVIS_SDK int32_t	GetFrameWidth ()
	Returns the current width of frames of the decoded video stream. More...

DB_EDGEVIS_SDK VideoSourceFormat	GetVideoSourceFormat ()
	Returns the current VideoSourceFormat of the video stream. More...

DB_EDGEVIS_SDK void	SetEnablePathSmoothing (bool enable)
	Enables smoothing of actor analytics path data. More...

DB_EDGEVIS_SDK bool	GetEnablePathSmoothing ()
	Returns true if actor analytics path smoothing is enabled. More...

DB_EDGEVIS_SDK void	SetEnableOnvifMetadata (bool enable, bool enable_extensions=true)
	Enables ONVIF style XML metadata for analytics. More...

DB_EDGEVIS_SDK bool	GetEnableOnvifMetadata ()
	Returns true if ONVIF metadata is enabled. More...

DB_EDGEVIS_SDK int64_t	GetViewerTimeoutDuration () const
	Returns the time in milliseconds that the stream will time out after if idle. More...

DB_EDGEVIS_SDK int64_t	GetViewerTimeRemaining () const
	Returns the time in milliseconds remaining until the stream times out. More...

DB_EDGEVIS_SDK void	ResetViewerTimeout ()
	Resets the stream timeout timer.

DB_EDGEVIS_SDK void	SetViewerTimeoutEnabled (bool enabled)
	Enables or disables the stream timeout for viewers.

DB_EDGEVIS_SDK FrameConfig	GetVideoFrameConfig ()
	Get the format configuration for video frames provided by the MediaStream. More...

DB_EDGEVIS_SDK bool	SetVideoFrameConfig (FrameConfig config)
	Set the format configuration for video frames provided by the MediaStream. More...

DB_EDGEVIS_SDK size_t	MaxVideoConverters () const
	Maximum number of simultaneous video conversions available on this media stream. More...

DB_EDGEVIS_SDK void	RequestH264IFrame ()
	Instruct the MediaStream to generate an H264 I frame. More...

DB_EDGEVIS_SDK AudioConfig	GetAudioConfig ()
	Get the format configuration for audio frames provided by the MediaStream. More...

DB_EDGEVIS_SDK bool	SetAudioConfig (AudioConfig config)
	Set the format configuration for audio provided by the MediaStream. More...

DB_EDGEVIS_SDK size_t	MaxAudioConverters () const
	Maximum number of simultaneous audio conversions available on this media stream. More...

virtual DB_EDGEVIS_SDK bool	IsConnected () const
	Checks if the media stream is currently connected. More...

DB_EDGEVIS_SDK Stream *	AsStream ()
	Returns the media stream object. More...

Public Member Functions inherited from EdgeVisDecoderSDK::Stream
DB_EDGEVIS_SDK StreamType	Type () const
	Gets the stream type. More...

DB_EDGEVIS_SDK std::wstring	Name () const
	Gets the stream's name. More...

virtual DB_EDGEVIS_SDK OpResult	SetTransport (TransportType trans)
	This is underlying transport type. More...

virtual DB_EDGEVIS_SDK TransportType	GetTransport ()
	Gets the stream's transport. More...

DB_EDGEVIS_SDK Encoder	GetEncoder () const
	Gets the Encoder object that the Stream is on. More...

DB_EDGEVIS_SDK OpResult	Open ()
	Opens the stream. More...

DB_EDGEVIS_SDK void	Close ()
	Closes this stream. More...

DB_EDGEVIS_SDK void	RegisterListener (IStreamListener *listener)
	Registers the specified listener to be notified when stream data is received. More...

DB_EDGEVIS_SDK void	UnregisterListener (IStreamListener *listener)
	Removes the specified listener from the set of listeners to be notified about incoming stream data. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesSent ()
	Returns the current total number of bytes sent on this stream. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesReceived ()
	Returns the current total number of bytes received on this stream. More...

DB_EDGEVIS_SDK void	ResetDataUsageStats ()
	Resets the count of the total number of bytes sent and received for this stream.

DB_EDGEVIS_SDK int64_t	GetStreamUseDuration () const
	Get the duration in milliseconds that the stream has been open. More...

DB_EDGEVIS_SDK int64_t	GetLastStreamUseDuration () const
	Get the duration in milliseconds that the stream was open on last use. More...

DB_EDGEVIS_SDK void	SetEnableAnalyticsSync (bool enable)
	Enables or disables synchronization of analytics metadata with audio and video Enabled by default, to disable set to false. More...

DB_EDGEVIS_SDK bool	GetEnableAnalyticsSync () const
	Returns true if Analytics Sync is enabled. More...

Member Function Documentation

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetEnableSCTData ( bool enable )

Enables the SCTData callback on the listener.

SCTData is the raw, not decoded TVI video stream. Disabled by default, to receive callbacks set to TRUE

Parameters

enable Set True to enable the callbacks

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::GetEnableSCTData ( )

Returns if the SCTData callbacks are enabled.

See also: SetEnableSCTData

Returns: True if SCTData callbacks are enabled

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetEnableIndexedSCTData ( bool enable )

Enables the SCTIndexedData callback on the listener.

SCTIndexed data is suitable for recording the RAW stream to disk for later playback. Disabled by default, to receive callbacks set to TRUE. This will require additional processing, only enable if required.

Parameters

enable Set True to enable the SCTIndexedData processing

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::GetEnableIndexedSCTData ( )

Returns true if the SCTIndexedData is enabled.

See also: SetEnableIndexedSCTData

Returns: True if SCTIndexedData is enabled

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetEnableAudioData ( bool enable )

Enables the Audio data callback on the listener.

Enabled by default, to disable set to false.

Parameters

enable Set False to disable the audio callbacks

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::GetEnableAudioData ( )

Returns true if the audio callbacks are enabled.

See also: SetEnableAudioData

Returns: True if audio data is enabled

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::GetLastFrame ( YCbCrFrame & destination )

Returns the last frame of video as a YCbCrFrame.

Parameters

destination An empty YCbCrFrame to populate with the last frame

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::EnableFullResBuffer	(	int32_t	fullResBufferSize,
		int32_t	memoryQuota,
		int32_t	fullResFps,
		int32_t	KeepInflated
	)

Enables the full resolution feature on the encoder.

This will increase the amount processing required for the DecoderSDK and increase the amount of memory required on the client. Only enable if the feature is being used by the client.

Parameters

fullResBufferSize	The number of frames to cache locally. Suggested value of 200 is used
memoryQuota	The amount of memory to use to store the cached frames. In bytes, suggested value of 25000000
fullResFps	The maximum number for fps to cache. Suggested value of 10.
KeepInflated	The maximum number of frames to keep inflated. Suggested value of 10

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::DisableFullResBuffer ( )

Enables the full resolution feature on the encoder.

This will free any frames cached locally

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetFullResJPEGQuality ( int32_t quality )

Sets the quality of the JPEG frame as cached locally.

This does not affect the quality of the JPEG stored on the remote encoder.

Parameters

quality The quality of the JPEG frame from 1 to 100. Default is 25

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFullResJPEGQuality ( )

Returns the value of the JPEG frame as cached locally.

Returns: The JPEG quality

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetFullResMaxInflatedFrames ( int32_t maxInflatedFrames )

Sets the maximum number of frames to keep inflated.

Parameters

maxInflatedFrames The maximum number of frames to keep inflated

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFullResMaxInflatedFrames ( )

Returns the maximum number of frames to keep inflated.

Returns: The maximum number of inflated frames

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetFullResFps ( int32_t fps )

Sets the maximum number for fps for the full resolution cache.

Parameters

fps	The maximum fps.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFullResFps ( )

Returns the maximum number for fps for the full resolution cache.

Returns: The fps set

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetFullResMaxCachedFrames ( int32_t maxCachedFrames )

Sets the maximum number of frames to cache for the Full Resolution feature.

Parameters

maxCachedFrames The maximum number of frames

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFullResMaxCachedFrames ( )

Returns the maximum number of frames being cached for the Full Resolution feature.

Returns: The number of frames set.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetStreamBandwidth ( )

Returns the current bandwidth of the media stream in bits per second.

Returns: The current bandwidth

DB_EDGEVIS_SDK double EdgeVisDecoderSDK::MediaStream::GetFrameRate ( )

Returns the current frames per second of the decoded video stream.

This may be different to the rate that frames are provided to the application if a FrameConfig has been applied to the MediaStream via the SetVideoFrameConfig() method.

Returns: The current decoded frames per second

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFrameHeight ( )

Returns the current height of frames of the decoded video stream.

Returns: The current height of frames

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MediaStream::GetFrameWidth ( )

Returns the current width of frames of the decoded video stream.

Returns: The current width of frames

DB_EDGEVIS_SDK VideoSourceFormat EdgeVisDecoderSDK::MediaStream::GetVideoSourceFormat ( )

Returns the current VideoSourceFormat of the video stream.

Returns: The current VideoSourceFormat

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetEnablePathSmoothing ( bool enable )

Enables smoothing of actor analytics path data.

Disabled by default, to enable set to true.

Parameters

enable Set True to enable path smoothing

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::GetEnablePathSmoothing ( )

Returns true if actor analytics path smoothing is enabled.

See also: SetEnablePathSmoothing

Returns: True if actor analytics path smoothing is enabled

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::SetEnableOnvifMetadata	(	bool	enable,
		bool	enable_extensions = `true`
	)

Enables ONVIF style XML metadata for analytics.

Disabled by default, to enable set to true.

Note that if the AnalyticsStream is configured and in use for the Encoder that the OnvifMetadata will be provided only from the AnalyticsStream and will not be duplicated on the MediaStream.

Parameters

enable	Set True to enable ONVIF metadata
enable_extensions	Set True to enable EdgeVis specific ONVIF extensions for per-frame metadata

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::GetEnableOnvifMetadata ( )

Returns true if ONVIF metadata is enabled.

See also: SetEnableOnvifMetadata

Returns: True if ONVIF metadata is enabled

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::MediaStream::GetViewerTimeoutDuration ( ) const

Returns the time in milliseconds that the stream will time out after if idle.

Returns: Time in milliseconds until the idle stream times out. A value of -1 indicates that the timeout is not yet known. A value of 0 indicates that there is no timeout in effect.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::MediaStream::GetViewerTimeRemaining ( ) const

Returns the time in milliseconds remaining until the stream times out.

Returns: Time in milliseconds remaining until the stream times out A value of -1 indicates that the timeout is not yet known. A value of 0 indicates that there is no timeout in effect.

DB_EDGEVIS_SDK FrameConfig EdgeVisDecoderSDK::MediaStream::GetVideoFrameConfig ( )

Get the format configuration for video frames provided by the MediaStream.

The default frame configuration is YCbCrFrameConfig with a height of 0 and max_fps of 30fps.

Returns: The frame configuration currently in use. Supported types are YCbCrFrameConfig, RGBFrameConfig, JPEGFrameConfig and H264FrameConfig.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::SetVideoFrameConfig ( FrameConfig config )

Set the format configuration for video frames provided by the MediaStream.

Parameters

config The frame configuration to apply. Supported types are YCbCrFrameConfig, RGBFrameConfig, JPEGFrameConfig and H264FrameConfig.

Returns: True if the video frame configuration was applied successfully, false if it failed.

DB_EDGEVIS_SDK size_t EdgeVisDecoderSDK::MediaStream::MaxVideoConverters ( ) const

Maximum number of simultaneous video conversions available on this media stream.

Returns: Max video converters.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::MediaStream::RequestH264IFrame ( )

Instruct the MediaStream to generate an H264 I frame.

This has no effect if the MediaStream is not configured for H264 output.

DB_EDGEVIS_SDK AudioConfig EdgeVisDecoderSDK::MediaStream::GetAudioConfig ( )

Get the format configuration for audio frames provided by the MediaStream.

The default configuration is PCM 16.

Returns: The audio configuration currently in use

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::SetAudioConfig ( AudioConfig config )

Set the format configuration for audio provided by the MediaStream.

Parameters

config The audio configuration to apply.

Returns: True if the configuration was applied successfully, false if it failed.

DB_EDGEVIS_SDK size_t EdgeVisDecoderSDK::MediaStream::MaxAudioConverters ( ) const

Maximum number of simultaneous audio conversions available on this media stream.

Returns: Max video converters.

virtual DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MediaStream::IsConnected ( ) const

virtual

Checks if the media stream is currently connected.

Returns: True if the stream is connected

Reimplemented from EdgeVisDecoderSDK::Stream.

DB_EDGEVIS_SDK Stream* EdgeVisDecoderSDK::MediaStream::AsStream ( )

Returns the media stream object.

Returns: The Stream object

The documentation for this class was generated from the following file:

SDKs/EdgeVisDecoderSDK/MediaStream.h

Detailed Description

Availability

Public Member Functions

Member Function Documentation