FFprobeSession class

An FFprobe session.

Inheritance

Constructors

FFprobeSession()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancel() Future<void>
Cancels running the session.
inherited
getAllLogs([int? waitTimeout = null]) Future<List<Log>>
Returns all log entries generated for this session. If there are asynchronous logs that are not delivered yet, this method waits for them until waitTimeout.
inherited
getAllLogsAsString([int? waitTimeout = null]) Future<String?>
Returns all log entries generated for this session as a concatenated string. If there are asynchronous logs that are not delivered yet, this method waits for them until waitTimeout.
inherited
getArguments() List<String>?
Returns command arguments as an array.
inherited
getCommand() String?
Returns command arguments as a concatenated string.
inherited
getCompleteCallback() FFprobeSessionCompleteCallback?
Returns the session specific complete callback.
getCreateTime() DateTime?
Returns session create time.
inherited
getDuration() Future<int>
Returns time taken to execute this session in milliseconds or zero (0) if the session is not over yet.
inherited
getEndTime() Future<DateTime?>
Returns session end time.
inherited
getFailStackTrace() Future<String?>
Returns the stack trace of the exception received while executing this session.
inherited
getLogCallback() LogCallback?
Returns the session specific log callback.
inherited
getLogRedirectionStrategy() LogRedirectionStrategy?
Returns session specific log redirection strategy.
inherited
getLogs() Future<List<Log>>
Returns all log entries delivered for this session. Note that if there are asynchronous logs that are not delivered yet, this method will not wait for them and will return immediately.
inherited
getLogsAsString() Future<String>
Returns all log entries delivered for this session as a concatenated string. Note that if there are asynchronous logs that are not delivered yet, this method will not wait for them and will return immediately.
inherited
getOutput() Future<String?>
Returns the log output generated while running the session.
inherited
getReturnCode() Future<ReturnCode?>
Returns the return code for this session. Note that return code is only set for sessions that end with COMPLETED state. If a session is not started, still running or failed then this method returns null.
inherited
getSessionId() int?
Returns the session identifier.
inherited
getStartTime() DateTime?
Returns session start time.
inherited
getState() Future<SessionState>
Returns the state of the session.
inherited
isFFmpeg() bool
Returns whether it is an "FFmpeg" session or not.
override
isFFprobe() bool
Returns whether it is an "FFprobe" session or not.
override
isMediaInformation() bool
Returns whether it is an "MediaInformation" session or not.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
thereAreAsynchronousMessagesInTransmit() Future<bool>
Returns whether there are still asynchronous messages being transmitted for this session or not.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

create(List<String> argumentsArray, [FFprobeSessionCompleteCallback? completeCallback = null, LogCallback? logCallback = null, LogRedirectionStrategy? logRedirectionStrategy = null]) Future<FFprobeSession>
Creates a new FFprobe session with argumentsArray.