![]() |
FFmpegKit iOS / macOS / tvOS API 4.5
|
#import <FFmpegKitConfig.h>
Configuration class of FFmpegKit
library. Allows customizing the global library options. Provides helper methods to support additional resources.
Definition at line 49 of file FFmpegKitConfig.h.
+ (NSString *) argumentsToString: | (NSArray*) | arguments |
Concatenates arguments into a string adding a space character between two arguments.
arguments | arguments |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncFFmpegExecute: | (FFmpegSession*) | ffmpegSession |
Asynchronously executes the FFmpeg session provided.
ffmpegSession | FFmpeg session which includes command options/arguments |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncFFmpegExecute: | (FFmpegSession*) | ffmpegSession | |
onDispatchQueue: | (dispatch_queue_t) | queue | |
Asynchronously executes the FFmpeg session provided.
ffmpegSession | FFmpeg session which includes command options/arguments |
queue | dispatch queue that will be used to run this asynchronous operation |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncFFprobeExecute: | (FFprobeSession*) | ffprobeSession |
Asynchronously executes the FFprobe session provided.
ffprobeSession | FFprobe session which includes command options/arguments |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncFFprobeExecute: | (FFprobeSession*) | ffprobeSession | |
onDispatchQueue: | (dispatch_queue_t) | queue | |
Asynchronously executes the FFprobe session provided.
ffprobeSession | FFprobe session which includes command options/arguments |
queue | dispatch queue that will be used to run this asynchronous operation |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncGetMediaInformationExecute: | (MediaInformationSession*) | mediaInformationSession | |
onDispatchQueue: | (dispatch_queue_t) | queue | |
withTimeout: | (int) | waitTimeout | |
Asynchronously executes the media information session provided.
mediaInformationSession | media information session which includes command options/arguments |
queue | dispatch queue that will be used to run this asynchronous operation |
waitTimeout | max time to wait until media information is transmitted |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) asyncGetMediaInformationExecute: | (MediaInformationSession*) | mediaInformationSession | |
withTimeout: | (int) | waitTimeout | |
Asynchronously executes the media information session provided.
mediaInformationSession | media information session which includes command options/arguments |
waitTimeout | max time to wait until media information is transmitted |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) clearSessions |
Clears all, including ongoing, sessions in the session history.
Note that callbacks cannot be triggered for deleted sessions.
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) closeFFmpegPipe: | (NSString*) | ffmpegPipePath |
Closes a previously created FFmpeg
pipe.
ffmpegPipePath | full path of the FFmpeg pipe |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) disableRedirection |
Disables log and statistics redirection.
When redirection is disabled logs are printed to stderr, all logs and statistics callbacks are disabled and FFprobe
's getMediaInformation
methods do not work.
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) enableExecuteCallback: | (ExecuteCallback) | executeCallback |
Sets a global execute callback to receive execution results.
executeCallback | execute callback or nil to disable a previously execute callback |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) enableLogCallback: | (LogCallback) | logCallback |
Sets a global log callback to redirect FFmpeg/FFprobe logs.
logCallback | log callback or nil to disable a previously defined log callback |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) enableRedirection |
Enables log and statistics redirection.
When redirection is enabled FFmpeg/FFprobe logs are redirected to NSLog and sessions collect log and statistics entries for the executions. It is possible to define global or session specific log/statistics callbacks as well.
Note that redirection is enabled by default. If you do not want to use its functionality please use disableRedirection method to disable it.
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) enableStatisticsCallback: | (StatisticsCallback) | statisticsCallback |
Sets a global statistics callback to redirect FFmpeg statistics.
statisticsCallback | statistics callback or nil to disable a previously defined statistics callback |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) ffmpegExecute: | (FFmpegSession*) | ffmpegSession |
Synchronously executes the FFmpeg session provided.
ffmpegSession | FFmpeg session which includes command options/arguments |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) ffprobeExecute: | (FFprobeSession*) | ffprobeSession |
Synchronously executes the FFprobe session provided.
ffprobeSession | FFprobe session which includes command options/arguments |
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) getBuildDate |
Returns FFmpegKit library build date.
Definition at line 149 of file FFmpegKitConfig.m.
+ (ExecuteCallback) getExecuteCallback |
Returns the global execute callback.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSArray *) getFFmpegSessions |
Returns all FFmpeg sessions in the session history.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) getFFmpegVersion |
Returns the version of FFmpeg bundled within FFmpegKit
library.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSArray *) getFFprobeSessions |
Returns all FFprobe sessions in the session history.
Definition at line 149 of file FFmpegKitConfig.m.
+ (id< Session >) getLastCompletedSession |
Returns the last session completed from the session history.
Definition at line 149 of file FFmpegKitConfig.m.
+ (id< Session >) getLastSession |
Returns the last session created from the session history.
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) getLogLevel |
Returns the current log level.
Definition at line 149 of file FFmpegKitConfig.m.
+ (LogRedirectionStrategy) getLogRedirectionStrategy |
Returns the active log redirection strategy.
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) getMediaInformationExecute: | (MediaInformationSession*) | mediaInformationSession | |
withTimeout: | (int) | waitTimeout | |
Synchronously executes the media information session provided.
mediaInformationSession | media information session which includes command options/arguments |
waitTimeout | max time to wait until media information is transmitted |
Definition at line 149 of file FFmpegKitConfig.m.
+ (id< Session >) getSession: | (long) | sessionId |
Returns the session specified with sessionId
from the session history.
sessionId | session identifier |
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) getSessionHistorySize |
Returns the session history size.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSArray *) getSessions |
Returns all sessions in the session history.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSArray *) getSessionsByState: | (SessionState) | state |
Returns sessions that have the given state.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) getVersion |
Returns FFmpegKit library version.
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) ignoreSignal: | (Signal) | signal |
Registers a new ignored signal. Ignored signals are not handled by FFmpegKit
library.
signal | signal to be ignored |
Definition at line 149 of file FFmpegKitConfig.m.
|
implementation |
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) isLTSBuild |
Returns whether FFmpegKit release is a Long Term Release or not.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) logLevelToString: | (int) | level |
Converts int log level to string.
level | value |
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) messagesInTransmit: | (long) | sessionId |
Returns the number of async messages that are not transmitted to the callbacks for this session.
sessionId | id of the session |
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSArray *) parseArguments: | (NSString*) | command |
Parses the given command into arguments. Uses space character to split the arguments. Supports single and double quote characters.
command | string command |
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) registerNewFFmpegPipe |
Creates a new named pipe to use in FFmpeg
operations.
Please note that creator is responsible of closing created pipes.
Definition at line 149 of file FFmpegKitConfig.m.
+ (NSString *) sessionStateToString: | (SessionState) | state |
Converts session state to string.
state | session state |
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) setEnvironmentVariable: | (NSString*) | variableName | |
value: | (NSString*) | variableValue | |
Sets an environment variable.
variableName | environment variable name |
variableValue | environment variable value |
Definition at line 149 of file FFmpegKitConfig.m.
+ (int) setFontconfigConfigurationPath: | (NSString*) | path |
Sets and overrides fontconfig
configuration directory.
path | directory that contains fontconfig configuration (fonts.conf) |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) setFontDirectory: | (NSString*) | fontDirectoryPath | |
with: | (NSDictionary*) | fontNameMapping | |
Registers the fonts inside the given path, so they become available to use in FFmpeg filters.
Note that you need to build FFmpegKit
with fontconfig
enabled or use a prebuilt package with fontconfig
inside to be able to use fonts in FFmpeg
.
fontDirectoryPath | directory that contains fonts (.ttf and .otf files) |
fontNameMapping | custom font name mappings, useful to access your fonts with more friendly names |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) setFontDirectoryList: | (NSArray*) | fontDirectoryList | |
with: | (NSDictionary*) | fontNameMapping | |
Registers the fonts inside the given array of font directories, so they become available to use in FFmpeg filters.
Note that you need to build FFmpegKit
with fontconfig
enabled or use a prebuilt package with fontconfig
inside to be able to use fonts in FFmpeg
.
fontDirectoryList | array of directories that contain fonts (.ttf and .otf files) |
fontNameMapping | custom font name mappings, useful to access your fonts with more friendly names |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) setLogLevel: | (int) | level |
+ (void) setLogRedirectionStrategy: | (LogRedirectionStrategy) | logRedirectionStrategy |
Sets the log redirection strategy
logRedirectionStrategy | log redirection strategy |
Definition at line 149 of file FFmpegKitConfig.m.
+ (void) setSessionHistorySize: | (int) | sessionHistorySize |
Sets the session history size.
sessionHistorySize | session history size, should be smaller than 1000 |
Definition at line 149 of file FFmpegKitConfig.m.