Bånder

HLSExporter extends MediaExporter

in package

• Application

uses EncryptsHLSSegments

Table of Contents

Constants

ENCRYPTION_LISTENER  = "listen-encryption-key"

HLS_KEY_INFO_FILENAME  = 'hls_encryption.keyinfo'

Properties

$concatWithAudio  : bool

$concatWithTranscoding  : bool

$concatWithVideo  : bool

$driver  : PHPFFMpeg

$lastPercentage  : float

$lastRemaining  : float

$maps  : Collection

$mustBeAccurate  : bool

$onProgressCallback  : Closure

$returnFrameContents  : bool

$timelapseFramerate  : float

$visibility  : string

$encryptionIV  : string

Encryption IV

$encryptionKey  : string

The encryption key.

$encryptionKeyFilename  : string

The encryption key filename.

$encryptionSecretsRoot  : mixed

Disk to store the secrets.

$keyFrameInterval  : int

$listener  : StdListener

Listener that will rotate the key.

$nextEncryptionFilenameAndKey  : array<string|int, mixed>

A fresh filename and encryption key for the next round.

$onNewEncryptionKey  : callable

Gets called whenever a new encryption key is set.

$pendingFormats  : Collection

$playlistGenerator  : PlaylistGenerator

$rotateEncryptiongKey  : bool

Wether to rotate the key on every segment.

$segmentFilenameGenerator  : Closure

$segmentLength  : int

$segmentsOpened  : int

Number of opened segments.

$segmentsPerKey  : int

Number of segments that can use the same key.

Methods

__call()  : mixed

Forwards the call to the driver object and returns the result if it's something different than the driver object itself.

__construct()  : mixed

accurate()  : self

addFormat()  : self

Initializes the $pendingFormats property when needed and adds the format with the optional callback to add filters.

addFormatOutputMapping()  : mixed

addTileFilter()  : self

Calls the callable with a TileFactory instance and adds the freshly generated TileFilter.

afterSaving()  : self

Adds a callable to the callbacks array.

asTimelapseWithFramerate()  : self

concatWithTranscoding()  : self

dd()  : void

Dump the final command and end the script.

generateEncryptionKey()  : string

Creates a new encryption key.

generateEncryptionKeyFilename()  : string

Creates a new encryption key filename.

generateTemporarySegmentPlaylistFilename()  : string

Returns the filename of a segment playlist by its key. We let FFmpeg generate a playlist for each added format so we don't have to detect the bitrate and codec ourselves.

getAccuracy()  : bool

getCommand()  : mixed

Prepares the saves command but returns the command instead.

getFrameContents()  : string

getProcessOutput()  : ProcessOutput

inFormat()  : self

onProgress()  : HasProgressListener|MediaExporter

Setter for the callback.

save()  : MediaOpener

Runs the export, generates the main playlist, and cleans up the segment playlist guides and temporary HLS encryption keys.

setKeyFrameInterval()  : self

Setter for the Key Frame interval

setSegmentLength()  : self

Setter for the segment length

toDisk()  : mixed

unaccurate()  : self

useSegmentFilenameGenerator()  : self

Setter for a callback that generates a segment filename.

withEncryptionKey()  : HLSExporter|EncryptsHLSSegments

Initialises the disk, info and IV for encryption and sets the key.

withPlaylistGenerator()  : self

Method to set a different playlist generator than the default HLSPlaylistGenerator.

withRotatingEncryptionKey()  : HLSExporter|EncryptsHLSSegments

Enables encryption with rotating keys. The callable will receive every new key and the integer sets the number of segments that can use the same key.

withVisibility()  : mixed

addTimelapseParametersToFormat()  : mixed

getDisk()  : Disk

getMediaOpener()  : MediaOpener

runAfterSavingCallbacks()  : mixed

addConcatFilterAndMapping()  : mixed

addHandlerToRotateEncryptionKey()  : void

Adds a listener and handler to rotate the key on every new HLS segment.

addHLSParametersToFormat()  : array<string|int, mixed>

Merges the HLS parameters to the given format.

applyFiltersCallback()  : array<string|int, mixed>

Gives the callback an HLSVideoFilters object that provides addFilter(), addLegacyFilter(), addWatermark() and resize() helper methods. It returns a mapping for the video and (optional) audio stream.

applyProgressListenerToFormat()  : void

Only calls the callback if the percentage is below 100 and is different from the previous emitted percentage.

cleanupHLSEncryption()  : HLSExporter|EncryptsHLSSegments

Removes the encryption keys from the temporary disk.

cleanupSegmentPlaylistGuides()  : self

Loops through each added format and then deletes the temporary segment playlist, which we generate manually using the HLSPlaylistGenerator.

getEncrypedHLSParameters()  : array<string|int, mixed>

Returns an array with the encryption parameters.

getPlaylistGenerator()  : PlaylistGenerator

getSegmentFilenameGenerator()  : callable

Returns a default generator if none is set.

getSegmentPatternAndFormatPlaylistPath()  : array<string|int, mixed>

Calls the generator with the path (without extension), format and key.

prepareSaving()  : Collection

Adds a mapping for each added format and automatically handles the mapping for filters. Adds a handler to rotate the encryption key (optional).

removeHandlerThatRotatesEncryptionKey()  : HLSExporter|EncryptsHLSSegments

Remove the listener at the end of the export to prevent duplicate event handlers.

replaceAbsolutePathsHLSEncryption()  : HLSExporter|EncryptsHLSSegments

While encoding, the encryption keys are saved to a temporary directory.

rotateEncryptionKey()  : string

Rotates the key and returns the absolute path to the info file. This method should be executed as fast as possible, or we might be too late for FFmpeg opening the next segment. That's why we don't use the Disk-class magic.