Task.setCheckCancellable

Sets or clears task's check-cancellable flag. If this is TRUE (the default), then Task.propagatePointer, etc, and Task.hadError will check the task's gio.Cancellable first, and if it has been cancelled, then they will consider the task to have returned an "Operation was cancelled" error (G_IO_ERROR_CANCELLED), regardless of any other error or return value the task may have had.

If check_cancellable is FALSE, then the gstreamer.Task will not check the cancellable itself, and it is up to task's owner to do this (eg, via Task.returnErrorIfCancelled).

If you are using Task.setReturnOnCancel as well, then you must leave check-cancellable set TRUE.

class Task
void
setCheckCancellable

Parameters

checkCancellable bool

whether gstreamer.Task will check the state of its gio.Cancellable for you.

Meta

Since

2.36