Class HTTPMJPEGSourceSettings

Namespace

VisioForge.Core.Types.X.Sources

Assembly

VisioForge.Core.dll

HTTP MJPEG source settings.

public class HTTPMJPEGSourceSettings : HTTPSourceSettings, IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Inheritance

object

HTTPSourceSettings

HTTPMJPEGSourceSettings

Implements

IMediaPlayerBaseSourceSettings

IVideoCaptureBaseVideoSourceSettings

IVideoMixerSource

IVideoSourceSettings

IMediaBlockSettings

Inherited Members

HTTPSourceSettings.AutomaticRedirect

HTTPSourceSettings.Compress

HTTPSourceSettings.Cookies

HTTPSourceSettings.ExtraHeaders

HTTPSourceSettings.HTTPLogLevel

HTTPSourceSettings.InternetRadioMode

HTTPSourceSettings.IsLive

HTTPSourceSettings.KeepAlive

HTTPSourceSettings.Location

HTTPSourceSettings.Method

HTTPSourceSettings.Proxy

HTTPSourceSettings.ProxyUserId

HTTPSourceSettings.ProxyPassword

HTTPSourceSettings.Retries

HTTPSourceSettings.SSLCAFile

HTTPSourceSettings.SSLStrict

HTTPSourceSettings.SSLUseSystemCAFile

HTTPSourceSettings.Timeout

HTTPSourceSettings.UserAgent

HTTPSourceSettings.UserID

HTTPSourceSettings.UserPassword

HTTPSourceSettings.FallbackSwitch

HTTPSourceSettings.ReadInfoAsync()

HTTPSourceSettings.CreateBlock()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

Context

Gets or sets the context for structured logging.

public BaseContext Context { get; set; }

Property Value

BaseContext

CustomVideoFrameRate

Gets or sets the custom video frame rate. Usually MJPEG cameras do not provide frame rate information.

public VideoFrameRate CustomVideoFrameRate { get; set; }

Property Value

VideoFrameRate

Latency

Gets or sets the latency (buffer size).

public TimeSpan Latency { get; set; }

Property Value

TimeSpan

Methods

CreateAsync(Uri, string, string, bool)

Create as an asynchronous operation.

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

Parameters

uri Uri

The URI.

login string

The login.

password string

The password.

readInfo bool

if set to true to read information. Disable only if you have some issues.

Returns

Task<HTTPMJPEGSourceSettings>

A Task<RTSPSourceSettings> representing the asynchronous operation.

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

Create as an asynchronous operation, optionally routing log output through the supplied context.

public static Task<HTTPMJPEGSourceSettings> CreateAsync(Uri uri, string login, string password, bool readInfo, BaseContext context)

Parameters

uri Uri

The URI.

login string

The login.

password string

The password.

readInfo bool

if set to true to read information. Disable only if you have some issues.

context BaseContext

Optional context for structured logging. When null, output falls back to Trace.

Returns

Task<HTTPMJPEGSourceSettings>

A Task<HTTPMJPEGSourceSettings> representing the asynchronous operation.

CreateBlock()

Creates the block. Overrides the base implementation so callers via either VisioForge.Core.Types.X.Sources.HTTPSourceSettings or VisioForge.Core.Types.X.Sources.HTTPMJPEGSourceSettings always get an MJPEG-aware source block.

public override MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetInfo()

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

public MediaFileInfo GetInfo()

Returns

MediaFileInfo

MediaFileInfo.

IsAudioAvailable()

Determines whether audio available.

public bool IsAudioAvailable()

Returns

bool

true if audio available; otherwise, false.

IsVideoAvailable()

Determines whether video available.

public bool IsVideoAvailable()

Returns

bool

true if video available; otherwise, false.

ReadInfoAsync()

Read information as an asynchronous operation. Overrides the base no-op in VisioForge.Core.Types.X.Sources.HTTPSourceSettings.ReadInfoAsync so callers holding either the base or derived type get the MJPEG probe.

public override Task<MediaFileInfo> ReadInfoAsync()

Returns

Task<MediaFileInfo>

A Task<MediaFileInfo> representing the asynchronous operation.