Class PapirflyPlaySetupOptions

Options passed to PapirflyPlay (javascript)

Inheritance
System.Object
PapirflyPlaySetupOptions
Namespace: ImageVault.Common.Html
Assembly: ImageVault.Common.dll
Syntax
public class PapirflyPlaySetupOptions : Object

Constructors

PapirflyPlaySetupOptions()

Declaration
public PapirflyPlaySetupOptions()

Properties

ActiveTextTrackLanguage

Instructs the player to select a specific text language as default

Declaration
public string ActiveTextTrackLanguage { get; set; }
Property Value
Type Description
System.String
Remarks

You can specify a comma separated list and the first language that matches a track will be the selected one. Both captions and subtitles are checked.

Examples

sv,en will instruct the player to first select a swedish track if exists and if not, an english one if that exists. If none of these languages has any text tracks, no track is selected as default

Autoplay

If video should start playing when loaded

Declaration
public bool Autoplay { get; set; }
Property Value
Type Description
System.Boolean

Controls

Should controls be active, if not, only way to start video is if autoplay is active or using api

Declaration
public bool Controls { get; set; }
Property Value
Type Description
System.Boolean

Debug

If debug output should be printed to console

Declaration
public bool Debug { get; set; }
Property Value
Type Description
System.Boolean

DefaultQuality

The default quality stream to use (in pixels)

Declaration
public Nullable<int> DefaultQuality { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

DisableFullscreen

If fullscreen should be disabled

Declaration
public bool DisableFullscreen { get; set; }
Property Value
Type Description
System.Boolean

DisableLoaderIcon

If the loader icon should be disabled

Declaration
public bool DisableLoaderIcon { get; set; }
Property Value
Type Description
System.Boolean

DisableTextTracks

If all text tracks should be disabled

Declaration
public bool DisableTextTracks { get; set; }
Property Value
Type Description
System.Boolean

DisplayDuringInit

If player should be visible during init or not

Declaration
public bool DisplayDuringInit { get; set; }
Property Value
Type Description
System.Boolean

EmbedResizeMode

Dictates the resize mode of the player

Declaration
public EmbedResizeMode EmbedResizeMode { get; set; }
Property Value
Type Description
EmbedResizeMode

InitBackground

Custom background of parent container during init

Declaration
public string InitBackground { get; set; }
Property Value
Type Description
System.String

KeyFrameInterval

Keyframe interval (used by trim editor)

Declaration
public Nullable<double> KeyFrameInterval { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

Lang

Language of the player

Declaration
public string Lang { get; set; }
Property Value
Type Description
System.String

Loop

If content should be looped or not (defaults to false)

Declaration
public bool Loop { get; set; }
Property Value
Type Description
System.Boolean

ManifestUrl

Contains the url to the manifest file that contains the information about the video

Declaration
public string ManifestUrl { get; set; }
Property Value
Type Description
System.String

Muted

If video should start with audio muted

Declaration
public bool Muted { get; set; }
Property Value
Type Description
System.Boolean

PlaysInline

Represents the playsinline attribute of the video tag. See PlaysInline

Declaration
public bool PlaysInline { get; set; }
Property Value
Type Description
System.Boolean

Poster

Set poster to video player

Declaration
public string Poster { get; set; }
Property Value
Type Description
System.String

Skin

Css class to add to the azure media player

Declaration
public string Skin { get; set; }
Property Value
Type Description
System.String

Methods

Create(RenderContext)

Create an instance based on the supplied context

Declaration
public static PapirflyPlaySetupOptions Create(RenderContext context)
Parameters
Type Name Description
RenderContext context
Returns
Type Description
PapirflyPlaySetupOptions

ToJson()

Converts the option class to a json string suitable to pass to the setupAsync method.

Declaration
public string ToJson()
Returns
Type Description
System.String
Remarks

Only properties that should be passed to the setupAsync method should be serialized to json

ToNameValueCollection()

Creates a name value collection based on the values of this instance

Declaration
public NameValueCollection ToNameValueCollection()
Returns
Type Description
System.Collections.Specialized.NameValueCollection
Remarks

The collection is to be used as query string parameters to the AzureMediaPlayer embedded player contained in the iframe

TryParse(String, out PapirflyPlaySetupOptions)

Tries to parse the supplied string

Declaration
public static bool TryParse(string data, out PapirflyPlaySetupOptions options)
Parameters
Type Name Description
System.String data
PapirflyPlaySetupOptions options
Returns
Type Description
System.Boolean

Extension Methods