AbstractSession class

Abstract session implementation which includes common features shared by "FFmpeg", "FFprobe" and "MediaInformation" sessions.

Inheritance
Implementers

Constructors

AbstractSession()

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() → void
Cancels running the session.
override
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.
override
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.
override
getArguments() List<String>?
Returns command arguments as an array.
override
getCommand() String?
Returns command arguments as a concatenated string.
override
getCreateTime() DateTime?
Returns session create time.
override
getDuration() Future<int>
Returns time taken to execute this session in milliseconds or zero (0) if the session is not over yet.
override
getEndTime() Future<DateTime?>
Returns session end time.
override
getFailStackTrace() Future<String?>
Returns the stack trace of the exception received while executing this session.
override
getLogCallback() LogCallback?
Returns the session specific log callback.
override
getLogRedirectionStrategy() LogRedirectionStrategy?
Returns session specific log redirection strategy.
override
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.
override
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.
override
getOutput() Future<String?>
Returns the log output generated while running the session.
override
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.
override
getSessionId() int?
Returns the session identifier.
override
getStartTime() DateTime?
Returns session start time.
override
getState() Future<SessionState>
Returns the state of the session.
override
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.
override
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

createFFmpegSession(List<String> argumentsArray, [LogRedirectionStrategy? logRedirectionStrategy = null]) Future<FFmpegSession>
Creates a new FFmpeg session using argumentsArray and logRedirectionStrategy.
createFFmpegSessionFromMap(Map sessionMap) FFmpegSession
Creates a new FFmpeg session from sessionMap, which includes session fields as map keys.
createFFprobeSession(List<String> argumentsArray, [LogRedirectionStrategy? logRedirectionStrategy = null]) Future<FFprobeSession>
Creates a new FFprobe session using argumentsArray and logRedirectionStrategy.
createFFprobeSessionFromMap(Map sessionMap) FFprobeSession
Creates a new FFprobe session from sessionMap, which includes session fields as map keys.
createMediaInformationSession(List<String> argumentsArray) Future<MediaInformationSession>
Creates a new MediaInformation session using argumentsArray.
createMediaInformationSessionFromMap(Map sessionMap) MediaInformationSession
Creates a new MediaInformation session from sessionMap, which includes session fields as map keys.

Constants

defaultTimeoutForAsynchronousMessagesInTransmit → const int
Defines how long default "getAll" methods wait, in milliseconds.