Functions

init (argv)

init_check (argv)

Details

Clapper.init(argv)
Parameters:

argv ([str] or None) – pointer to application’s argv

Returns:

pointer to application’s argv

Return type:

argv: [str]

Initializes the Clapper library. Implementations must always call this before using Clapper API.

Because Clapper uses GStreamer internally, this function will also initialize GStreamer before initializing Clapper itself for user convienience, so application does not have to do so anymore.

WARNING: This function will terminate your program if it was unable to initialize for some reason. If you want to do some fallback logic, use [func`Clapper`.init_check] instead.

Clapper.init_check(argv)
Parameters:

argv ([str] or None) – pointer to application’s argv

Returns:

True if Clapper could be initialized, False otherwise.

argv:

pointer to application’s argv

Return type:

(bool, argv: [str])

This function does the same thing as [func`Clapper`.init], but instead of terminating on failure it returns False.