Table of Contents

Class HTTPSourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

HTTP/HTTPS source settings. Implements the VisioForge.Core.Types.X.MediaPlayer.IMediaPlayerBaseSourceSettings. Implements the VisioForge.Core.Types.X.VideoCapture.IVideoCaptureBaseVideoSourceSettings.

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

Inheritance

Derived

Implements

Inherited Members

Constructors

HTTPSourceSettings(Uri, bool)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.HTTPSourceSettings class.

public HTTPSourceSettings(Uri uri, bool live = true)

Parameters

uri Uri

The URI.

live bool

if set to true is live.

Properties

AutomaticRedirect

Automatically follow HTTP redirects (HTTP Status Code 3xx). Default value: true.

public bool AutomaticRedirect { get; set; }

Property Value

bool

Compress

Allow compressed content encodings. Default value: false.

public bool Compress { get; set; }

Property Value

bool

Cookies

HTTP request cookies.

public string[] Cookies { get; set; }

Property Value

string[]

ExtraHeaders

Extra headers to append to the HTTP request.

public Dictionary<string, string> ExtraHeaders { get; }

Property Value

Dictionary<string, string>

FallbackSwitch

Gets or sets the fallback switch settings for automatic failover. When configured, the source will automatically switch to a fallback (static text, image, or media) when the main HTTP/HTTPS stream fails.

public FallbackSwitchSettings FallbackSwitch { get; set; }

Property Value

FallbackSwitchSettings

HTTPLogLevel

Set log level for SOUP's HTTP session log. Default value: headers (2).

public HTTPSourceSettings.SOUPLoggerLogLevel HTTPLogLevel { get; set; }

Property Value

HTTPSourceSettings.SOUPLoggerLogLevel

InternetRadioMode

Enable internet radio mode (ask server to send shoutcast/icecast metadata interleaved with the actual stream data). Default value: true.

public bool InternetRadioMode { get; set; }

Property Value

bool

IsLive

Act like a live source. Default value: false.

public bool IsLive { get; set; }

Property Value

bool

KeepAlive

Use HTTP persistent connections. Default value: true.

public bool KeepAlive { get; set; }

Property Value

bool

Location

Location to read from. Default value: NULL.

public Uri Location { get; set; }

Property Value

Uri

Method

The HTTP method to use (GET, HEAD, OPTIONS, etc). Default value: NULL.

public string Method { get; set; }

Property Value

string

Proxy

HTTP proxy server URI.

public string Proxy { get; set; }

Property Value

string

ProxyPassword

HTTP proxy URI user password for authentication. Default value: NULL.

public string ProxyPassword { get; set; }

Property Value

string

ProxyUserId

HTTP proxy URI user id for authentication. Default value: NULL.

public string ProxyUserId { get; set; }

Property Value

string

Retries

Maximum number of retries until giving up (-1=infinite). Default value: 3.

public int Retries { get; set; }

Property Value

int

SSLCAFile

Location of a SSL anchor CA file to use. Default value: NULL.

public string SSLCAFile { get; set; }

Property Value

string

SSLStrict

Strict SSL certificate checking. Default value: true.

public bool SSLStrict { get; set; }

Property Value

bool

SSLUseSystemCAFile

Use system CA file. Default value: true.

public bool SSLUseSystemCAFile { get; set; }

Property Value

bool

Timeout

Value in seconds to timeout a blocking I/O (0 = No timeout). Default value: 15.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

UserAgent

Value of the User-Agent HTTP request header field. Default value: GStreamer souphttpsrc {VERSION}.

public string UserAgent { get; set; }

Property Value

string

UserID

HTTP location URI user id for authentication. Default value: NULL.

public string UserID { get; set; }

Property Value

string

UserPassword

HTTP location URI user password for authentication. Default value: NULL.

public string UserPassword { get; set; }

Property Value

string

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

ReadInfoAsync()

Reads the information asynchronous.

public Task<MediaFileInfo> ReadInfoAsync()

Returns

Task<MediaFileInfo>

Task<MediaFileInfo>.

See Also