Class HTTPSourceSettings

HTTP/HTTPS source settings. Implements the IMediaPlayerBaseSourceSettings. Implements the IVideoCaptureBaseVideoSourceSettings.

Inheritance

object

HTTPSourceSettings

HTTPMJPEGSourceSettings

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 HTTPSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Constructors

HTTPSourceSettings(Uri, bool)

Initializes a new instance of the HTTPSourceSettings class.

Declaration

public HTTPSourceSettings(Uri uri, bool live = true)

Parameters

Type	Name	Description
Uri	uri	The URI.
bool	live	if set to true is live.

Properties

AutomaticRedirect

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

Declaration

public bool AutomaticRedirect { get; set; }

Property Value

Type	Description
bool

Compress

Allow compressed content encodings. Default value: false.

Declaration

public bool Compress { get; set; }

Property Value

Type	Description
bool

Cookies

HTTP request cookies.

Declaration

public string[] Cookies { get; set; }

Property Value

Type	Description
string[]

ExtraHeaders

Extra headers to append to the HTTP request.

Declaration

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

Property Value

Type	Description
Dictionary<string, string>

HTTPLogLevel

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

Declaration

public HTTPSourceSettings.SOUPLoggerLogLevel HTTPLogLevel { get; set; }

Property Value

Type	Description
HTTPSourceSettings.SOUPLoggerLogLevel

InternetRadioMode

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

Declaration

public bool InternetRadioMode { get; set; }

Property Value

Type	Description
bool

IsLive

Act like a live source. Default value: false.

Declaration

public bool IsLive { get; set; }

Property Value

Type	Description
bool

KeepAlive

Use HTTP persistent connections. Default value: true.

Declaration

public bool KeepAlive { get; set; }

Property Value

Type	Description
bool

Location

Location to read from. Default value: NULL.

Declaration

public Uri Location { get; set; }

Property Value

Type	Description
Uri

Method

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

Declaration

public string Method { get; set; }

Property Value

Type	Description
string

Proxy

HTTP proxy server URI.

Declaration

public string Proxy { get; set; }

Property Value

Type	Description
string

ProxyPassword

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

Declaration

public string ProxyPassword { get; set; }

Property Value

Type	Description
string

ProxyUserId

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

Declaration

public string ProxyUserId { get; set; }

Property Value

Type	Description
string

Retries

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

Declaration

public int Retries { get; set; }

Property Value

Type	Description
int

SSLCAFile

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

Declaration

public string SSLCAFile { get; set; }

Property Value

Type	Description
string

SSLStrict

Strict SSL certificate checking. Default value: true.

Declaration

public bool SSLStrict { get; set; }

Property Value

Type	Description
bool

SSLUseSystemCAFile

Use system CA file. Default value: true.

Declaration

public bool SSLUseSystemCAFile { get; set; }

Property Value

Type	Description
bool

Timeout

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

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

UserAgent

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

Declaration

public string UserAgent { get; set; }

Property Value

Type	Description
string

UserID

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

Declaration

public string UserID { get; set; }

Property Value

Type	Description
string

UserPassword

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

Declaration

public string UserPassword { get; set; }

Property Value

Type	Description
string

Methods

CreateBlock()

Creates the block.

Declaration

public MediaBlock CreateBlock()

Returns

Type	Description
MediaBlock	MediaBlock.

ReadInfoAsync()

Reads the information asynchronous.

Declaration

public Task<MediaFileInfo> ReadInfoAsync()

Returns

Type	Description
Task<MediaFileInfo>	Task<MediaFileInfo>.

Implements

IMediaPlayerBaseSourceSettings

IVideoCaptureBaseVideoSourceSettings

IVideoMixerSource

IVideoSourceSettings

IMediaBlockSettings

See Also

IMediaPlayerBaseSourceSettings

IVideoCaptureBaseVideoSourceSettings