DeviceProvider

A #GstDeviceProvider subclass is provided by a plugin that handles devices if there is a way to programatically 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 {}

Constructors

this
this(GstDeviceProvider* gstDeviceProvider, bool ownedRef)

Sets our main struct and passes it to the parent class.

Members

Classes

OnProviderHiddenDelegateWrapper
class OnProviderHiddenDelegateWrapper
Undocumented in source.
OnProviderUnhiddenDelegateWrapper
class OnProviderUnhiddenDelegateWrapper
Undocumented in source.

Functions

addOnProviderHidden
gulong addOnProviderHidden(void delegate(string, DeviceProvider) dlg, ConnectFlags connectFlags)
addOnProviderUnhidden
gulong addOnProviderUnhidden(void delegate(string, DeviceProvider) dlg, ConnectFlags connectFlags)
canMonitor
bool canMonitor()
deviceAdd
void deviceAdd(Device device)

Posts a message on the provider's #GstBus to inform applications that a new device has been added.

deviceRemove
void deviceRemove(Device device)

Posts a message on the provider's #GstBus to inform applications that a device has been removed.

getBus
Bus getBus()

Gets the #GstBus of this #GstDeviceProvider

getDeviceProviderStruct
GstDeviceProvider* getDeviceProviderStruct()

Get the main Gtk struct

getDevices
ListG getDevices()

Gets a list of devices that this provider understands. This may actually probe the hardware if the provider is not currently started.

getFactory
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.

getStruct
void* getStruct()

the main Gtk struct as a void*

hideProvider
void hideProvider(string name)

Make @provider hide the devices from the factory with @name.

internalRemoveOnProviderHidden
void internalRemoveOnProviderHidden(OnProviderHiddenDelegateWrapper source)
Undocumented in source. Be warned that the author may not have intended to support it.
internalRemoveOnProviderUnhidden
void internalRemoveOnProviderUnhidden(OnProviderUnhiddenDelegateWrapper source)
Undocumented in source. Be warned that the author may not have intended to support it.
setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
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_start() was called.

unhideProvider
void unhideProvider(string name)

Make @provider unhide the devices from factory @name.

Static functions

callBackProviderHidden
void callBackProviderHidden(GstDeviceProvider* deviceproviderStruct, char* object, OnProviderHiddenDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackProviderHiddenDestroy
void callBackProviderHiddenDestroy(OnProviderHiddenDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackProviderUnhidden
void callBackProviderUnhidden(GstDeviceProvider* deviceproviderStruct, char* object, OnProviderUnhiddenDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackProviderUnhiddenDestroy
void callBackProviderUnhiddenDestroy(OnProviderUnhiddenDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()
register
bool register(Plugin plugin, string name, uint rank, GType type)

Create a new device providerfactory capable of instantiating objects of the @type and add the factory to @plugin.

Variables

gstDeviceProvider
GstDeviceProvider* gstDeviceProvider;

the main Gtk struct

onProviderHiddenListeners
OnProviderHiddenDelegateWrapper[] onProviderHiddenListeners;
Undocumented in source.
onProviderUnhiddenListeners
OnProviderUnhiddenDelegateWrapper[] onProviderUnhiddenListeners;
Undocumented in source.

Inherited Members

From ObjectGst

gstObject
GstObject* gstObject;

the main Gtk struct

getObjectGstStruct
GstObject* getObjectGstStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()
checkUniqueness
bool checkUniqueness(ListG 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(ObjectG object, ObjectGst orig, 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.

refSink
void* refSink(void* object)

Increase the reference count of @object, and possibly remove the floating reference, if @object has a floating reference.

replace
bool replace(ObjectGst oldobj, 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(ControlBinding binding)

Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.

defaultError
void defaultError(ErrorG error, string dbg)

A default error function that uses g_printerr() to display the error message and the optional debug sting..

getControlBinding
ControlBinding getControlBinding(string propertyName)

Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.

getControlRate
GstClockTime 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_sync_values() inbetween. The length of the processing segment should be up to @control-rate nanoseconds.

getGValueArray
bool getGValueArray(string propertyName, GstClockTime timestamp, GstClockTime interval, uint nValues, 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 g_free() the return value after usage. For a nameless object, this returns %NULL, which you can safely g_free() as well.

getParent
ObjectGst getParent()

Returns the parent of @object. This function increases the refcount of the parent object so you should gst_object_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
Value getValue(string propertyName, GstClockTime timestamp)

Gets the value for the given controlled property at the requested time.

getValueArray
bool getValueArray(string propertyName, GstClockTime timestamp, GstClockTime interval, uint nValues, void* values)

Gets a number of values for the given controlled property starting at the requested time. The array @values need to hold enough space for @n_values of the same type as the objects property's type.

hasActiveControlBindings
bool hasActiveControlBindings()

Check if the @object has active controlled properties.

hasAncestor
bool hasAncestor(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(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(ObjectGst parent)

Check if @parent is the parent of @object. E.g. a #GstElement can check if it owns a given #GstPad.

doref
ObjectGst doref()

Increments the reference count on @object. This function does not take the lock on @object because it relies on atomic refcounting.

removeControlBinding
bool removeControlBinding(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_sync_values() 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_sync_values() will do nothing.

setControlRate
void setControlRate(GstClockTime 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_sync_values() inbetween. 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(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_ref_sink()).

suggestNextSync
GstClockTime suggestNextSync()

Returns a suggestion for timestamps where buffers should be split to get best controller results.

syncValues
bool syncValues(GstClockTime 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.

unref
void unref()

Decrements the reference count on @object. If reference count hits zero, destroy @object. This function does not take the lock on @object as it relies on atomic refcounting.

OnDeepNotifyDelegateWrapper
class OnDeepNotifyDelegateWrapper
Undocumented in source.
onDeepNotifyListeners
OnDeepNotifyDelegateWrapper[] onDeepNotifyListeners;
Undocumented in source.
addOnDeepNotify
gulong addOnDeepNotify(void delegate(ObjectGst, ParamSpec, ObjectGst) dlg, ConnectFlags connectFlags)

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

callBackDeepNotify
void callBackDeepNotify(GstObject* objectgstStruct, GstObject* propObject, GParamSpec* prop, OnDeepNotifyDelegateWrapper wrapper)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackDeepNotifyDestroy
void callBackDeepNotifyDestroy(OnDeepNotifyDelegateWrapper wrapper, GClosure* closure)
Undocumented in source. Be warned that the author may not have intended to support it.
internalRemoveOnDeepNotify
void internalRemoveOnDeepNotify(OnDeepNotifyDelegateWrapper source)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta