Table of Contents

Class HLSSinkSettings

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

HLS sink settings.

public class HLSSinkSettings

Inheritance

Inherited Members

Properties

Custom_HTTP_Server_Enabled

Gets or sets a value indicating whether the custom HTTP server enabled.

public bool Custom_HTTP_Server_Enabled { get; set; }

Property Value

bool

Custom_HTTP_Server_Port

Gets or sets the custom HTTP server port.

public int Custom_HTTP_Server_Port { get; set; }

Property Value

int

EnableEndlist

Gets or sets whether to add #EXT-X-ENDLIST tag at the end of the playlist (hlssink3/hlscmafsink only).

public bool EnableEndlist { get; set; }

Property Value

bool

EnableProgramDateTime

Gets or sets whether to enable program date time tags in the playlist (hlssink3/hlscmafsink only). Adds #EXT-X-PROGRAM-DATE-TIME tags to the playlist for synchronization.

public bool EnableProgramDateTime { get; set; }

Property Value

bool

IFramesOnly

Gets or sets whether to create I-frames only playlist (hlssink3 only).

public bool IFramesOnly { get; set; }

Property Value

bool

InitLocation

Gets or sets the init segment location pattern (hlscmafsink only). Used for CMAF initialization segments.

public string InitLocation { get; set; }

Property Value

string

Latency

Gets or sets the latency (hlscmafsink only).

public TimeSpan Latency { get; set; }

Property Value

TimeSpan

Location

Gets or sets the location pattern for segment files. For hlssink2/hlssink3: segment_%05d.ts For hlscmafsink: segment_%05d.m4s

public string Location { get; set; }

Property Value

string

MaxFiles

Gets or sets the maximum number of files to keep on disk. Once the maximum is reached, old files start to be deleted to make room for new ones.

public uint MaxFiles { get; set; }

Property Value

uint

PdtFollowsPipelineClock

Gets or sets whether program date time should follow the pipeline clock (hlssink3/hlscmafsink only).

public bool PdtFollowsPipelineClock { get; set; }

Property Value

bool

PlaylistLength

Gets or sets the length of the HLS playlist. By HLS specification, this should be at least 3. If set to 0, the playlist will be infinite.

public uint PlaylistLength { get; set; }

Property Value

uint

PlaylistLocation

Gets or sets the location of the playlist to write.

public string PlaylistLocation { get; set; }

Property Value

string

PlaylistRoot

Gets or sets the playlist root URL for segments in the playlist.

public string PlaylistRoot { get; set; }

Property Value

string

PlaylistType

Gets or sets the playlist type (hlssink3/hlscmafsink only). Controls whether the playlist is for live streaming (Unspecified), event, or VOD.

public HLSPlaylistType PlaylistType { get; set; }

Property Value

HLSPlaylistType

SendKeyframeRequests

Gets or sets a value indicating whether to send keyframe requests to ensure correct fragmentation. If this is disabled, then the input must have keyframes in regular intervals.

public bool SendKeyframeRequests { get; set; }

Property Value

bool

SinkType

Gets or sets the HLS sink implementation type to use.

public HLSSinkType SinkType { get; set; }

Property Value

HLSSinkType

Sync

Gets or sets whether to sync with clock for live streaming (hlscmafsink only). Required for proper timeout handling in live pipelines.

public bool Sync { get; set; }

Property Value

bool

TargetDuration

Gets or sets the target duration of a segment/file. TimeSpan.Zero - disabled, useful for management of segment duration by the streaming server.

public TimeSpan TargetDuration { get; set; }

Property Value

TimeSpan

Methods

CheckAndCreateFolders()

Checks if the directories for the output files exist and creates them if necessary.

public void CheckAndCreateFolders()