Class UniversalSourceSettings

Universal source settings.

Inheritance
object
UniversalSourceSettings
Implements
Inherited Members
Namespace: VisioForge.Core.Types.X.Sources
Assembly: VisioForge.Core.dll
Syntax
public class UniversalSourceSettings : IMediaPlayerBaseSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoMixerSource, IVideoSourceSettings, IMediaBlockSettings

Properties

DisableHWDecoders

Gets or sets a value indicating whether HW decoders will be disabled.

Declaration
public bool DisableHWDecoders { get; set; }
Property Value
Type Description
bool

true if disable HW decoders; otherwise, false.

MPEGTSProgramNumber

Gets or sets the MPEG-TS program number (optional).

Declaration
public int MPEGTSProgramNumber { get; set; }
Property Value
Type Description
int

The MPEG-TS program number.

RenderAudio

The render audio.

Declaration
public bool RenderAudio { get; }
Property Value
Type Description
bool

RenderSubtitle

The render subtitle.

Declaration
public bool RenderSubtitle { get; }
Property Value
Type Description
bool

RenderVideo

The render video.

Declaration
public bool RenderVideo { get; }
Property Value
Type Description
bool

StartPosition

Start position.

Declaration
public TimeSpan? StartPosition { get; set; }
Property Value
Type Description
TimeSpan?

StopPosition

Stop position.

Declaration
public TimeSpan? StopPosition { get; set; }
Property Value
Type Description
TimeSpan?

URI

Gets the URI.

Declaration
public Uri URI { get; }
Property Value
Type Description
Uri

UseAdvancedEngine

Gets or sets a value indicating whether to use advanced engine, with stream selection support.

Declaration
public bool UseAdvancedEngine { get; set; }
Property Value
Type Description
bool

true if [use advanced engine]; otherwise, false.

VideoCustomFrameRate

Gets or sets the video custom frame rate. If not set, then source frame rate will be used. Video frames will be dropped or duplicated to match this frame rate.

Declaration
public VideoFrameRate? VideoCustomFrameRate { get; set; }
Property Value
Type Description
VideoFrameRate?

The video custom frame rate.

Methods

CheckURI()

Checks the URI.

Declaration
public bool CheckURI()
Returns
Type Description
bool

bool.

CreateAsync(string, bool, bool, bool)

Create as an asynchronous operation.

Declaration
public static Task<UniversalSourceSettings> CreateAsync(string filename, bool renderVideo = true, bool renderAudio = true, bool renderSubtitle = false)
Parameters
Type Name Description
string filename

The file name.
bool renderVideo

if set to true render video.
bool renderAudio

if set to true render audio.
bool renderSubtitle

if set to true [render subtitle].
Returns
Type Description
Task<UniversalSourceSettings>

A Task<UniversalSourceSettings> representing the asynchronous operation.

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

Create as an asynchronous operation.

Declaration
public static Task<UniversalSourceSettings> CreateAsync(Uri uri, bool renderVideo = true, bool renderAudio = true, bool renderSubtitle = false, bool ignoreMediaInfoReader = false)
Parameters
Type Name Description
Uri uri

The URI.
bool renderVideo

if set to true render video.
bool renderAudio

if set to true render audio.
bool renderSubtitle

if set to true render subtitle.
bool ignoreMediaInfoReader

if set to true ignore media information reader.
Returns
Type Description
Task<UniversalSourceSettings>

A Task<UniversalSourceSettings> representing the asynchronous operation.

CreateBlock()

Creates the block.

Declaration
public MediaBlock CreateBlock()
Returns
Type Description
MediaBlock

MediaBlock.

GetInfo()

Gets the file information.

Declaration
public MediaFileInfo GetInfo()
Returns
Type Description
MediaFileInfo

MediaFileInfo.
Remarks

If VideoCustomFrameRate is set you'll have this value as a frame rate.

ReadInfoAsync()

Read information as an asynchronous operation.

Declaration
public Task<MediaFileInfo> ReadInfoAsync()
Returns
Type Description
Task<MediaFileInfo>

A Task<MediaFileInfo> representing the asynchronous operation.

Implements

IMediaPlayerBaseSourceSettings
IVideoCaptureBaseVideoSourceSettings
IVideoMixerSource
IVideoSourceSettings
IMediaBlockSettings