impl-factory.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_IMPL_FACTORY_H
#define PIPEWIRE_IMPL_FACTORY_H
#ifdef __cplusplus
extern "C" {
#endif
struct pw_impl_factory;
#include <pipewire/context.h>
#include <pipewire/impl-client.h>
#include <pipewire/global.h>
#include <pipewire/properties.h>
#include <pipewire/resource.h>
struct pw_impl_factory_events {
#define PW_VERSION_IMPL_FACTORY_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
void (*free) (void *data);
void (*initialized) (void *data);
};
struct pw_impl_factory_implementation {
#define PW_VERSION_IMPL_FACTORY_IMPLEMENTATION 0
uint32_t version;
void *(*create_object) (void *data,
struct pw_resource *resource,
const char *type,
uint32_t version,
struct pw_properties *properties,
uint32_t new_id);
};
struct pw_impl_factory *pw_context_create_factory(struct pw_context *context,
const char *name,
const char *type,
uint32_t version,
struct pw_properties *properties,
size_t user_data_size);
const struct pw_properties *pw_impl_factory_get_properties(struct pw_impl_factory *factory);
const struct pw_factory_info *pw_impl_factory_get_info(struct pw_impl_factory *factory);
int pw_impl_factory_update_properties(struct pw_impl_factory *factory, const struct spa_dict *dict);
int pw_impl_factory_register(struct pw_impl_factory *factory,
struct pw_properties *properties);
void pw_impl_factory_destroy(struct pw_impl_factory *factory);
void *pw_impl_factory_get_user_data(struct pw_impl_factory *factory);
struct pw_global *pw_impl_factory_get_global(struct pw_impl_factory *factory);
void pw_impl_factory_add_listener(struct pw_impl_factory *factory,
struct spa_hook *listener,
const struct pw_impl_factory_events *events,
void *data);
void pw_impl_factory_set_implementation(struct pw_impl_factory *factory,
const struct pw_impl_factory_implementation *implementation,
void *data);
void *pw_impl_factory_create_object(struct pw_impl_factory *factory,
struct pw_resource *resource,
const char *type,
uint32_t version,
struct pw_properties *properties,
uint32_t new_id);
struct pw_impl_factory *
pw_context_find_factory(struct pw_context *context ,
const char *name );
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_IMPL_FACTORY_H */
context.h
pipewire/context.h
global.h
pipewire/global.h
pw_impl_factory_destroy
void pw_impl_factory_destroy(struct pw_impl_factory *factory)
Definition: impl-factory.c:83
pw_impl_factory_get_properties
const struct pw_properties * pw_impl_factory_get_properties(struct pw_impl_factory *factory)
Get the factory properties.
Definition: impl-factory.c:148
pw_impl_factory_update_properties
int pw_impl_factory_update_properties(struct pw_impl_factory *factory, const struct spa_dict *dict)
Update the factory properties.
Definition: impl-factory.c:154
pw_impl_factory_get_global
struct pw_global * pw_impl_factory_get_global(struct pw_impl_factory *factory)
Get the global of this factory.
Definition: impl-factory.c:242
pw_impl_factory_set_implementation
void pw_impl_factory_set_implementation(struct pw_impl_factory *factory, const struct pw_impl_factory_implementation *implementation, void *data)
Definition: impl-factory.c:257
pw_impl_factory_get_info
const struct pw_factory_info * pw_impl_factory_get_info(struct pw_impl_factory *factory)
Get the factory info.
Definition: impl-factory.c:236
pw_context_create_factory
struct pw_impl_factory * pw_context_create_factory(struct pw_context *context, const char *name, const char *type, uint32_t version, struct pw_properties *properties, size_t user_data_size)
Definition: impl-factory.c:39
pw_context_find_factory
struct pw_impl_factory * pw_context_find_factory(struct pw_context *context, const char *name)
Find a factory by name.
Definition: impl-factory.c:291
pw_impl_factory_register
int pw_impl_factory_register(struct pw_impl_factory *factory, struct pw_properties *properties)
Definition: impl-factory.c:177
pw_impl_factory_add_listener
void pw_impl_factory_add_listener(struct pw_impl_factory *factory, struct spa_hook *listener, const struct pw_impl_factory_events *events, void *data)
Add an event listener.
Definition: impl-factory.c:248
pw_impl_factory_get_user_data
void * pw_impl_factory_get_user_data(struct pw_impl_factory *factory)
Definition: impl-factory.c:230
pw_impl_factory_create_object
void * pw_impl_factory_create_object(struct pw_impl_factory *factory, struct pw_resource *resource, const char *type, uint32_t version, struct pw_properties *properties, uint32_t new_id)
Definition: impl-factory.c:265
impl-client.h
pipewire/impl-client.h
properties.h
pipewire/properties.h
resource.h
pipewire/resource.h
pw_context
pw_factory_info
The factory information.
Definition: factory.h:61
pw_global
Definition: context.h:67
pw_impl_factory_events
Factory events, listen to them with pw_impl_factory_add_listener.
Definition: impl-factory.h:55
pw_impl_factory_events::version
uint32_t version
Definition: impl-factory.h:58
pw_impl_factory_events::initialized
void(* initialized)(void *data)
the factory is initialized
Definition: impl-factory.h:65
pw_impl_factory_events::destroy
void(* destroy)(void *data)
the factory is destroyed
Definition: impl-factory.h:61
pw_impl_factory_events::free
void(* free)(void *data)
the factory is freed
Definition: impl-factory.h:63
pw_impl_factory_implementation
Definition: impl-factory.h:68
pw_impl_factory_implementation::version
uint32_t version
Definition: impl-factory.h:71
pw_impl_factory
pw_properties
Definition: properties.h:53
pw_resource
Definition: impl.h:49
spa_dict
Definition: dict.h:59
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342