Interface IImageExtractionManager

Interface IImageExtractionManager.

Namespace: MediaBrowser.Controller.MediaEncoding

Assembly: MediaBrowser.Controller.dll

Syntax

public interface IImageExtractionManager

Methods

ExtractAudioImage(ReadOnlyMemory<Char>, Nullable<Int32>, CancellationToken)

Extracts the audio image.

Declaration

Task<string> ExtractAudioImage(ReadOnlyMemory<char> path, int? streamIndex, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	path	The path.
System.Nullable<System.Int32>	streamIndex	Index of the image stream.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task{Stream}.

ExtractAudioImage(String, Nullable<MediaContainers>, Nullable<Int32>, CancellationToken)

Extracts the audio image.

Declaration

Task<string> ExtractAudioImage(string path, MediaContainers? container, int? streamIndex, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	path	The path.
System.Nullable<MediaContainers>	container	The container.
System.Nullable<System.Int32>	streamIndex	Index of the image stream.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task{Stream}.

ExtractVideoImage(ReadOnlyMemory<Char>, Nullable<MediaContainers>, MediaProtocol, MediaStream, Nullable<Video3DFormat>, Nullable<TimeSpan>, CancellationToken)

Extracts the video image.

Declaration

Task<string> ExtractVideoImage(ReadOnlyMemory<char> inputPath, MediaContainers? container, MediaProtocol protocol, MediaStream videoStream, Video3DFormat? threedFormat, TimeSpan? offset, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	inputPath	The input path.
System.Nullable<MediaContainers>	container	The container.
MediaProtocol	protocol	The protocol.
MediaStream	videoStream	The video stream.
System.Nullable<Video3DFormat>	threedFormat	The threed format.
System.Nullable<System.TimeSpan>	offset	The offset.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

ExtractVideoImage(ReadOnlyMemory<Char>, Nullable<MediaContainers>, MediaProtocol, MediaStream, Nullable<Int32>, CancellationToken)

Extracts the video image.

Declaration

Task<string> ExtractVideoImage(ReadOnlyMemory<char> inputPath, MediaContainers? container, MediaProtocol protocol, MediaStream imageStream, int? streamIndex, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	inputPath	The input path.
System.Nullable<MediaContainers>	container	The container.
MediaProtocol	protocol	The protocol.
MediaStream	imageStream	The image stream.
System.Nullable<System.Int32>	streamIndex	Index of the stream.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

ExtractVideoImagesFromList(ReadOnlyMemory<Char>, Nullable<MediaContainers>, MediaStream, MediaProtocol, Nullable<Video3DFormat>, TimeSpan[], String, String, Nullable<Int32>, CancellationToken)

Extracts the video images from a list of time points.

Declaration

Task ExtractVideoImagesFromList(ReadOnlyMemory<char> inputPath, MediaContainers? container, MediaStream videoStream, MediaProtocol protocol, Video3DFormat? threedFormat, TimeSpan[] extractionTimes, string targetDirectory, string filenamePrefix, int? maxWidth, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	inputPath	The input path.
System.Nullable<MediaContainers>	container	The container.
MediaStream	videoStream	The video stream.
MediaProtocol	protocol	The protocol.
System.Nullable<Video3DFormat>	threedFormat	The threed format.
System.TimeSpan[]	extractionTimes	The extraction times.
System.String	targetDirectory	The target directory.
System.String	filenamePrefix	The filename prefix.
System.Nullable<System.Int32>	maxWidth	The maximum width.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task

ExtractVideoImagesOnInterval(ReadOnlyMemory<Char>, Nullable<MediaContainers>, MediaStream, MediaProtocol, Nullable<Video3DFormat>, TimeSpan, String, String, Nullable<Int32>, CancellationToken)

Extracts the video images on interval.

Declaration

Task ExtractVideoImagesOnInterval(ReadOnlyMemory<char> inputPath, MediaContainers? container, MediaStream videoStream, MediaProtocol protocol, Video3DFormat? threedFormat, TimeSpan interval, string targetDirectory, string filenamePrefix, int? maxWidth, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.ReadOnlyMemory<System.Char>	inputPath	The input path.
System.Nullable<MediaContainers>	container	The container.
MediaStream	videoStream	The video stream.
MediaProtocol	protocol	The protocol.
System.Nullable<Video3DFormat>	threedFormat	The threed format.
System.TimeSpan	interval	The interval.
System.String	targetDirectory	The target directory.
System.String	filenamePrefix	The filename prefix.
System.Nullable<System.Int32>	maxWidth	The maximum width.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)