DeviceProvider

A #GstDeviceProvider subclass is provided by a plugin that handles devices if there is a way to programmatically list connected devices. It can also optionally provide updates to the list of connected devices.

Each #GstDeviceProvider subclass is a singleton, a plugin should normally provide a single subclass for all devices.

Applications would normally use a #GstDeviceMonitor to monitor devices from all relevant providers.

class DeviceProvider : ObjectGst {

static bool register(gst.plugin.Plugin plugin, string name, uint rank, gobject.types.GType type);

bool canMonitor();

void deviceAdd(gst.device.Device device);

void deviceChanged(gst.device.Device device, gst.device.Device changedDevice);

void deviceRemove(gst.device.Device device);

gst.bus.Bus getBus();

gst.device.Device[] getDevices();

gst.device_provider_factory.DeviceProviderFactory getFactory();

string[] getHiddenProviders();

string getMetadata(string key);

void hideProvider(string name);

bool isStarted();

bool start();

void stop();

void unhideProvider(string name);

ulong connectProviderHidden(T callback, Flag!"After" after);

ulong connectProviderUnhidden(T callback, Flag!"After" after);

}

Members

Functions

canMonitor bool canMonitor()
connectProviderHidden ulong connectProviderHidden(T callback, Flag!"After" after): Connect to ProviderHidden signal.
connectProviderUnhidden ulong connectProviderUnhidden(T callback, Flag!"After" after): Connect to ProviderUnhidden signal.
deviceAdd void deviceAdd(gst.device.Device device): Posts a message on the provider's #GstBus to inform applications that a new device has been added.
deviceChanged void deviceChanged(gst.device.Device device, gst.device.Device changedDevice): This function is used when changed_device was modified into its new form device. This will post a DEVICE_CHANGED message on the bus to let the application know that the device was modified. #GstDevice is immutable for MT. safety purposes so this is an "atomic" way of letting the application know when a device was modified.
deviceRemove void deviceRemove(gst.device.Device device): Posts a message on the provider's #GstBus to inform applications that a device has been removed.
getBus gst.bus.Bus getBus(): Gets the #GstBus of this #GstDeviceProvider
getDevices gst.device.Device[] getDevices(): Gets a list of devices that this provider understands. This may actually probe the hardware if the provider is not currently started.
getFactory gst.device_provider_factory.DeviceProviderFactory getFactory(): Retrieves the factory that was used to create this device provider.
getHiddenProviders string[] getHiddenProviders(): Get the provider factory names of the #GstDeviceProvider instances that are hidden by provider.
getMetadata string getMetadata(string key): Get metadata with key in provider.
hideProvider void hideProvider(string name): Make provider hide the devices from the factory with name.
isStarted bool isStarted(): This function can be used to know if the provider was successfully started.
start bool start(): Starts providering the devices. This will cause #GST_MESSAGE_DEVICE_ADDED and #GST_MESSAGE_DEVICE_REMOVED messages to be posted on the provider's bus when devices are added or removed from the system.
stop void stop(): Decreases the use-count by one. If the use count reaches zero, this #GstDeviceProvider will stop providering the devices. This needs to be called the same number of times that gst.device_provider.DeviceProvider.start was called.
unhideProvider void unhideProvider(string name): Make provider unhide the devices from factory name.

Static functions

register bool register(gst.plugin.Plugin plugin, string name, uint rank, gobject.types.GType type): Create a new device providerfactory capable of instantiating objects of the type and add the factory to plugin.

Inherited Members

From ObjectGst

checkUniqueness bool checkUniqueness(gst.object.ObjectGst[] list, string name): Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object.
defaultDeepNotify void defaultDeepNotify(gobject.object.ObjectG object, gst.object.ObjectGst orig, gobject.param_spec.ParamSpec pspec, string[] excludedProps): A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.
replace bool replace(gst.object.ObjectGst oldobj, gst.object.ObjectGst newobj): Atomically modifies a pointer to point to a new object. The reference count of oldobj is decreased and the reference count of newobj is increased.
addControlBinding bool addControlBinding(gst.control_binding.ControlBinding binding): Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.
defaultError void defaultError(glib.error.ErrorG error, string debug_): A default error function that uses glib.global.printerr to display the error message and the optional debug string..
getControlBinding gst.control_binding.ControlBinding getControlBinding(string propertyName): Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.
getControlRate gst.types.ClockTime getControlRate(): Obtain the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
getGValueArray bool getGValueArray(string propertyName, gst.types.ClockTime timestamp, gst.types.ClockTime interval, gobject.value.Value[] values): Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.
getName string getName(): Returns a copy of the name of object. Caller should glib.global.gfree the return value after usage. For a nameless object, this returns null, which you can safely glib.global.gfree as well.
getParent gst.object.ObjectGst getParent(): Returns the parent of object. This function increases the refcount of the parent object so you should gst.object.ObjectGst.unref it after usage.
getPathString string getPathString(): Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.
getValue gobject.value.Value getValue(string propertyName, gst.types.ClockTime timestamp): Gets the value for the given controlled property at the requested time.
hasActiveControlBindings bool hasActiveControlBindings(): Check if the object has active controlled properties.
hasAncestor bool hasAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsAncestor bool hasAsAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsParent bool hasAsParent(gst.object.ObjectGst parent): Check if parent is the parent of object. E.g. a #GstElement can check if it owns a given #GstPad.
removeControlBinding bool removeControlBinding(gst.control_binding.ControlBinding binding): Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed.
setControlBindingDisabled void setControlBindingDisabled(string propertyName, bool disabled): This function is used to disable the control bindings on a property for some time, i.e. gst.object.ObjectGst.syncValues will do nothing for the property.
setControlBindingsDisabled void setControlBindingsDisabled(bool disabled): This function is used to disable all controlled properties of the object for some time, i.e. gst.object.ObjectGst.syncValues will do nothing.
setControlRate void setControlRate(gst.types.ClockTime controlRate): Change the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
setName bool setName(string name): Sets the name of object, or gives object a guaranteed unique name (if name is null). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.
setParent bool setParent(gst.object.ObjectGst parent): Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst.object.ObjectGst.refSink).
suggestNextSync gst.types.ClockTime suggestNextSync(): Returns a suggestion for timestamps where buffers should be split to get best controller results.
syncValues bool syncValues(gst.types.ClockTime timestamp): Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.
unparent void unparent(): Clear the parent of object, removing the associated reference. This function decreases the refcount of object.
connectDeepNotify ulong connectDeepNotify(string detail, T callback, Flag!"After" after): Connect to DeepNotify signal.

gst device_provider classes

DeviceProvider