Class RTSPSourceSettings

RTSP source settings.

Inheritance

object

RTSPSourceSettings

Implements

IMediaPlayerBaseSourceSettings

IVideoCaptureBaseVideoSourceSettings

IVideoMixerSource

IVideoSourceSettings

IMediaBlockSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.Types.X.Sources

Assembly: VisioForge.Core.dll

Syntax

public class RTSPSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Properties

AllowedProtocols

Gets or sets the allowed protocols.

Declaration

public RTSPSourceProtocol AllowedProtocols { get; set; }

Property Value

Type	Description
RTSPSourceProtocol

AudioEnabled

Gets or sets a value indicating whether audio stream is enabled.

Declaration

public bool AudioEnabled { get; set; }

Property Value

Type	Description
bool	true if audio stream is enabled; otherwise, false.

CompatibilityMode

Gets or sets a value indicating whether to use compatibility mode. In compatibility mode, the SDK will not try to read camera information, but will still try to open and play the stream inside the RTSPSourceBlock.

Declaration

public bool CompatibilityMode { get; set; }

Property Value

Type	Description
bool

CustomVideoDecoder

Gets or sets the custom video decoder to use.

Declaration

public string CustomVideoDecoder { get; set; }

Property Value

Type	Description
string

DoRTCP

Gets or sets a value indicating whether do RTCP.

Declaration

public bool DoRTCP { get; set; }

Property Value

Type	Description
bool	true if [do RTCP]; otherwise, false.

EnableRAWVideoAudioEvents

Gets or sets a value indicating whether to enable RAW audio/video events.

Declaration

public bool EnableRAWVideoAudioEvents { get; set; }

Property Value

Type	Description
bool

Latency

Gets or sets the latency (buffer size).

Declaration

public TimeSpan Latency { get; set; }

Property Value

Type	Description
TimeSpan

Login

Gets or sets IP camera login, if required.

Declaration

public string Login { get; set; }

Property Value

Type	Description
string

Password

Gets or sets IP camera password, if required.

Declaration

public string Password { get; set; }

Property Value

Type	Description
string

RTPBlockSize

Gets or sets the size of the RTP block.

Declaration

public int RTPBlockSize { get; set; }

Property Value

Type	Description
int

UDPBufferSize

Gets or sets the size of the UDP buffer.

Declaration

public int UDPBufferSize { get; set; }

Property Value

Type	Description
int

Uri

Gets or sets the URI.

Declaration

public Uri Uri { get; set; }

Property Value

Type	Description
Uri

UseGPUDecoder

Gets or sets a value indicating whether to use GPU decoder.

Declaration

public bool UseGPUDecoder { get; set; }

Property Value

Type	Description
bool

Methods

CreateAsync(Uri, string, string, bool, bool)

Create as an asynchronous operation.

Declaration

public static Task<RTSPSourceSettings> CreateAsync(Uri uri, string login, string password, bool audioEnabled, bool readInfo = true)

Parameters

Type	Name	Description
Uri	uri	The URI.
string	login	The login.
string	password	The password.
bool	audioEnabled	if set to true audio is enabled.
bool	readInfo	if set to true to read information. Disable only if you have some issues.

Returns

Type	Description
Task<RTSPSourceSettings>	A Task<RTSPSourceSettings> representing the asynchronous operation.

CreateBlock()

Creates the block.

Declaration

public MediaBlock CreateBlock()

Returns

Type	Description
MediaBlock	MediaBlock.

GetInfo()

Gets the information. Call the ReadInfoAsync method to get the information first.

Declaration

public MediaFileInfo GetInfo()

Returns

Type	Description
MediaFileInfo	MediaFileInfo.

GetVideoURLByONVIFAsync()

Get video URL by onvif as an asynchronous operation.

Declaration

public Task<bool> GetVideoURLByONVIFAsync()

Returns

Type	Description
Task<bool>	A Task<System.Boolean> representing the asynchronous operation.

IsAudioAvailable()

Determines whether audio available.

Declaration

public bool IsAudioAvailable()

Returns

Type	Description
bool	true if audio available; otherwise, false.

IsVideoAvailable()

Determines whether video available.

Declaration

public bool IsVideoAvailable()

Returns

Type	Description
bool	true if video available; otherwise, false.

ReadInfo()

Reads the information.

Declaration

public MediaFileInfo ReadInfo()

Returns

Type	Description
MediaFileInfo	MediaFileInfo.

ReadInfoAsync()

Reads the information asynchronous.

Declaration

public Task<MediaFileInfo> ReadInfoAsync()

Returns

Type	Description
Task<MediaFileInfo>	Task<MediaFileInfo>.

Implements

IMediaPlayerBaseSourceSettings

IVideoCaptureBaseVideoSourceSettings

IVideoMixerSource

IVideoSourceSettings

IMediaBlockSettings