mirror of
https://github.com/obsproject/obs-studio.git
synced 2026-01-19 11:48:41 -05:00
82 lines
4.1 KiB
Objective-C
82 lines
4.1 KiB
Objective-C
//
|
|
// plugin-properties.h
|
|
// obs-studio
|
|
//
|
|
// Created by Patrick Heyer on 2023-03-07.
|
|
//
|
|
|
|
@import Foundation;
|
|
|
|
#import <obs-properties.h>
|
|
|
|
/// Configures single source property's visibility, possible modification callback and callback payload data, as well as whether the property should be enabled
|
|
/// - Parameters:
|
|
/// - property: The source property to change
|
|
/// - enable: Whether the source property should be enabled (user-changeable)
|
|
/// - visible: Whether the source property should be visible
|
|
/// - callback: Pointer to a function that will be called if this property has been modified or the properties are reloaded
|
|
/// - capture: Optional reference to ``OBSAVCapture`` instance
|
|
void configure_property(obs_property_t *property, bool enable, bool visible, void *callback, OBSAVCapture *capture);
|
|
|
|
/// Generic callback handler for changed properties. Will update all properties of an OBSAVCapture source at once
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - properties: Pointer to properties struct associated with the source
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_changed(OBSAVCapture *capture, obs_properties_t *properties, obs_property_t *property,
|
|
obs_data_t *settings);
|
|
|
|
/// Callback handler for preset changes.
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - properties: Pointer to properties struct associated with the source
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_changed_preset(OBSAVCapture *capture, obs_properties_t *properties, obs_property_t *property,
|
|
obs_data_t *settings);
|
|
|
|
/// Callback handler for changing preset usage for an OBSAVCapture source. Switches between preset-based configuration and manual configuration
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - properties: Pointer to properties struct associated with the source
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_changed_use_preset(OBSAVCapture *capture, obs_properties_t *properties, obs_property_t *property,
|
|
obs_data_t *settings);
|
|
|
|
/// Updates preset property with description-value-pairs of presets supported by the currently selected device
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_update_preset(OBSAVCapture *capture, obs_property_t *property, obs_data_t *settings);
|
|
|
|
/// Updates device property with description-value-pairs of devices available via CoreMediaIO
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_update_device(OBSAVCapture *capture, obs_property_t *property, obs_data_t *settings);
|
|
|
|
/// Updates available values for all properties required in manual device configuration.
|
|
///
|
|
/// Properties updated by this call include:
|
|
/// * Device formats
|
|
/// * Frame rates and frame rate ranges
|
|
/// * Effects warnings
|
|
///
|
|
/// Frame rate ranges will be limited to ranges only available for a specific combination of resolution and color format.
|
|
///
|
|
/// - Parameters:
|
|
/// - capture: Pointer to ``OBSAVCapture`` instance
|
|
/// - property: Pointer to the property that the callback is attached to
|
|
/// - settings: Pointer to settings associated with the source
|
|
/// - Returns: Always returns true
|
|
bool properties_update_config(OBSAVCapture *capture, obs_properties_t *properties, obs_data_t *settings);
|