Open Broadcaster Software
Free, open source software for live streaming and recording
obs-properties.h
Go to the documentation of this file.
1 /******************************************************************************
2  Copyright (C) 2014 by Hugh Bailey <obs.jim@gmail.com>
3 
4  This program is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 2 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program. If not, see <http://www.gnu.org/licenses/>.
16 ******************************************************************************/
17 
18 #pragma once
19 
20 #include "util/c99defs.h"
21 #include "obs-data.h"
22 #include "media-io/frame-rate.h"
23 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
43 #define OBS_PROPERTIES_DEFER_UPDATE (1 << 0)
44 
59 };
60 
66 };
67 
72 };
73 
78 };
79 
84 };
85 
90 };
91 
95 };
96 
101 };
102 
103 #define OBS_FONT_BOLD (1 << 0)
104 #define OBS_FONT_ITALIC (1 << 1)
105 #define OBS_FONT_UNDERLINE (1 << 2)
106 #define OBS_FONT_STRIKEOUT (1 << 3)
107 
108 struct obs_properties;
109 struct obs_property;
110 typedef struct obs_properties obs_properties_t;
111 typedef struct obs_property obs_property_t;
112 
113 /* ------------------------------------------------------------------------- */
114 
117 obs_properties_create_param(void *param, void (*destroy)(void *param));
119 
120 EXPORT void obs_properties_set_flags(obs_properties_t *props, uint32_t flags);
122 
124  void (*destroy)(void *param));
126 
128 
130  const char *property);
131 
133 
145  const char *property);
146 
152  obs_data_t *settings);
153 
154 /* ------------------------------------------------------------------------- */
155 
162  obs_property_t *property, void *data);
163 
165  const char *name,
166  const char *description);
167 
169  const char *name,
170  const char *description, int min,
171  int max, int step);
172 
174  const char *name,
175  const char *description,
176  double min, double max,
177  double step);
178 
180  const char *name,
181  const char *description,
182  int min, int max,
183  int step);
184 
186  const char *name,
187  const char *description,
188  double min, double max,
189  double step);
190 
192  const char *name,
193  const char *description,
194  enum obs_text_type type);
195 
213 obs_properties_add_path(obs_properties_t *props, const char *name,
214  const char *description, enum obs_path_type type,
215  const char *filter, const char *default_path);
216 
218  const char *name,
219  const char *description,
220  enum obs_combo_type type,
221  enum obs_combo_format format);
222 
224  const char *name,
225  const char *description);
226 
229  const char *text, obs_property_clicked_t callback);
230 
233  const char *text, obs_property_clicked_t callback,
234  void *priv);
235 
246  const char *name,
247  const char *description);
248 
251  const char *description,
252  enum obs_editable_list_type type,
253  const char *filter, const char *default_path);
254 
256  const char *name,
257  const char *description);
258 
260  const char *name,
261  const char *description,
262  enum obs_group_type type,
263  obs_properties_t *group);
264 
265 /* ------------------------------------------------------------------------- */
266 
273  obs_property_t *property,
274  obs_data_t *settings);
275 typedef bool (*obs_property_modified2_t)(void *priv, obs_properties_t *props,
276  obs_property_t *property,
277  obs_data_t *settings);
278 
279 EXPORT void
281  obs_property_modified_t modified);
283  obs_property_t *p, obs_property_modified2_t modified, void *priv);
284 
287 
290 
292  const char *description);
294  const char *long_description);
295 
302 
304 
322 
324  int step);
326  double max, double step);
327 EXPORT void obs_property_int_set_suffix(obs_property_t *p, const char *suffix);
329  const char *suffix);
331 
333 
335  const char *val);
336 EXPORT size_t obs_property_list_add_int(obs_property_t *p, const char *name,
337  long long val);
339  double val);
340 
342  const char *name, const char *val);
344  const char *name, long long val);
346  const char *name, double val);
347 
349  bool disabled);
351 
353 
359 
364 
368 
370  const char *name,
371  const char *description);
374  struct media_frames_per_second max);
375 
377  const char *name,
378  const char *description);
379 EXPORT void
381  struct media_frames_per_second min,
382  struct media_frames_per_second max);
383 
386  size_t idx);
388  size_t idx);
389 
395 
398 
399 #ifndef SWIG
402 #endif
403 
404 #ifdef __cplusplus
405 }
406 #endif
OBS_GROUP_CHECKABLE
@ OBS_GROUP_CHECKABLE
Definition: obs-properties.h:100
obs_property_int_type
EXPORT enum obs_number_type obs_property_int_type(obs_property_t *p)
obs_property_float_max
EXPORT double obs_property_float_max(obs_property_t *p)
obs_group_type
obs_group_type
Definition: obs-properties.h:97
obs_property_float_min
EXPORT double obs_property_float_min(obs_property_t *p)
obs_properties_get_param
EXPORT void * obs_properties_get_param(obs_properties_t *props)
obs_properties_add_text
EXPORT obs_property_t * obs_properties_add_text(obs_properties_t *props, const char *name, const char *description, enum obs_text_type type)
obs_property_get_type
EXPORT enum obs_property_type obs_property_get_type(obs_property_t *p)
obs_property_float_suffix
EXPORT const char * obs_property_float_suffix(obs_property_t *p)
obs_properties_set_param
EXPORT void obs_properties_set_param(obs_properties_t *props, void *param, void(*destroy)(void *param))
obs_property_frame_rate_fps_ranges_count
EXPORT size_t obs_property_frame_rate_fps_ranges_count(obs_property_t *p)
obs_property_clicked_t
bool(* obs_property_clicked_t)(obs_properties_t *props, obs_property_t *property, void *data)
Definition: obs-properties.h:161
obs_property_list_item_name
EXPORT const char * obs_property_list_item_name(obs_property_t *p, size_t idx)
media_frames_per_second
Definition: frame-rate.h:7
OBS_PROPERTY_INVALID
@ OBS_PROPERTY_INVALID
Definition: obs-properties.h:46
obs_property_modified
EXPORT bool obs_property_modified(obs_property_t *p, obs_data_t *settings)
OBS_TEXT_MULTILINE
@ OBS_TEXT_MULTILINE
Definition: obs-properties.h:89
obs_properties_add_button
EXPORT obs_property_t * obs_properties_add_button(obs_properties_t *props, const char *name, const char *text, obs_property_clicked_t callback)
obs_property_name
EXPORT const char * obs_property_name(obs_property_t *p)
OBS_COMBO_TYPE_LIST
@ OBS_COMBO_TYPE_LIST
Definition: obs-properties.h:71
obs_property_frame_rate_option_name
EXPORT const char * obs_property_frame_rate_option_name(obs_property_t *p, size_t idx)
obs_property_float_step
EXPORT double obs_property_float_step(obs_property_t *p)
obs_property_list_item_int
EXPORT long long obs_property_list_item_int(obs_property_t *p, size_t idx)
obs_property_float_set_suffix
EXPORT void obs_property_float_set_suffix(obs_property_t *p, const char *suffix)
obs_editable_list_type
obs_editable_list_type
Definition: obs-properties.h:74
obs_combo_format
obs_combo_format
Definition: obs-properties.h:61
obs_property_set_modified_callback2
EXPORT void obs_property_set_modified_callback2(obs_property_t *p, obs_property_modified2_t modified, void *priv)
obs_property_group_content
EXPORT obs_properties_t * obs_property_group_content(obs_property_t *p)
obs_properties_create_param
EXPORT obs_properties_t * obs_properties_create_param(void *param, void(*destroy)(void *param))
obs_properties_get_parent
EXPORT obs_properties_t * obs_properties_get_parent(obs_properties_t *props)
obs_property_path_filter
EXPORT const char * obs_property_path_filter(obs_property_t *p)
obs_data_t
struct obs_data obs_data_t
Definition: obs-data.h:42
obs_properties_get_flags
EXPORT uint32_t obs_properties_get_flags(obs_properties_t *props)
obs_properties_add_int
EXPORT obs_property_t * obs_properties_add_int(obs_properties_t *props, const char *name, const char *description, int min, int max, int step)
obs_property_int_set_suffix
EXPORT void obs_property_int_set_suffix(obs_property_t *p, const char *suffix)
EXPORT
#define EXPORT
Definition: c99defs.h:37
obs_property_set_visible
EXPORT void obs_property_set_visible(obs_property_t *p, bool visible)
obs_property_set_modified_callback
EXPORT void obs_property_set_modified_callback(obs_property_t *p, obs_property_modified_t modified)
obs_properties_add_bool
EXPORT obs_property_t * obs_properties_add_bool(obs_properties_t *props, const char *name, const char *description)
obs_property_text_set_monospace
EXPORT void obs_property_text_set_monospace(obs_property_t *p, bool monospace)
obs_properties_add_group
EXPORT obs_property_t * obs_properties_add_group(obs_properties_t *props, const char *name, const char *description, enum obs_group_type type, obs_properties_t *group)
frame-rate.h
obs_property_set_enabled
EXPORT void obs_property_set_enabled(obs_property_t *p, bool enabled)
OBS_COMBO_FORMAT_FLOAT
@ OBS_COMBO_FORMAT_FLOAT
Definition: obs-properties.h:64
obs_property_editable_list_default_path
EXPORT const char * obs_property_editable_list_default_path(obs_property_t *p)
obs_property_set_description
EXPORT void obs_property_set_description(obs_property_t *p, const char *description)
OBS_PROPERTY_BUTTON
@ OBS_PROPERTY_BUTTON
Definition: obs-properties.h:54
obs-data.h
obs_property_float_type
EXPORT enum obs_number_type obs_property_float_type(obs_property_t *p)
OBS_COMBO_INVALID
@ OBS_COMBO_INVALID
Definition: obs-properties.h:98
OBS_EDITABLE_LIST_TYPE_FILES
@ OBS_EDITABLE_LIST_TYPE_FILES
Definition: obs-properties.h:76
obs_property_enabled
EXPORT bool obs_property_enabled(obs_property_t *p)
obs_property_list_insert_string
EXPORT void obs_property_list_insert_string(obs_property_t *p, size_t idx, const char *name, const char *val)
OBS_PROPERTY_LIST
@ OBS_PROPERTY_LIST
Definition: obs-properties.h:52
OBS_PROPERTY_FLOAT
@ OBS_PROPERTY_FLOAT
Definition: obs-properties.h:49
obs_properties_add_int_slider
EXPORT obs_property_t * obs_properties_add_int_slider(obs_properties_t *props, const char *name, const char *description, int min, int max, int step)
OBS_COMBO_FORMAT_INVALID
@ OBS_COMBO_FORMAT_INVALID
Definition: obs-properties.h:62
OBS_COMBO_FORMAT_STRING
@ OBS_COMBO_FORMAT_STRING
Definition: obs-properties.h:65
OBS_COMBO_TYPE_EDITABLE
@ OBS_COMBO_TYPE_EDITABLE
Definition: obs-properties.h:70
obs_property_frame_rate_fps_range_insert
EXPORT void obs_property_frame_rate_fps_range_insert(obs_property_t *p, size_t idx, struct media_frames_per_second min, struct media_frames_per_second max)
obs_property_list_item_float
EXPORT double obs_property_list_item_float(obs_property_t *p, size_t idx)
obs_property_float_set_limits
EXPORT void obs_property_float_set_limits(obs_property_t *p, double min, double max, double step)
obs_property_list_item_remove
EXPORT void obs_property_list_item_remove(obs_property_t *p, size_t idx)
obs_property_text_type
EXPORT enum obs_text_type obs_property_text_type(obs_property_t *p)
obs_property_path_type
EXPORT enum obs_path_type obs_property_path_type(obs_property_t *p)
OBS_NUMBER_SLIDER
@ OBS_NUMBER_SLIDER
Definition: obs-properties.h:94
obs_property_list_add_float
EXPORT size_t obs_property_list_add_float(obs_property_t *p, const char *name, double val)
OBS_PROPERTY_FRAME_RATE
@ OBS_PROPERTY_FRAME_RATE
Definition: obs-properties.h:57
c99defs.h
obs_property_path_default_path
EXPORT const char * obs_property_path_default_path(obs_property_t *p)
OBS_PROPERTY_TEXT
@ OBS_PROPERTY_TEXT
Definition: obs-properties.h:50
obs_properties_add_editable_list
EXPORT obs_property_t * obs_properties_add_editable_list(obs_properties_t *props, const char *name, const char *description, enum obs_editable_list_type type, const char *filter, const char *default_path)
OBS_PROPERTY_GROUP
@ OBS_PROPERTY_GROUP
Definition: obs-properties.h:58
obs_properties_add_float_slider
EXPORT obs_property_t * obs_properties_add_float_slider(obs_properties_t *props, const char *name, const char *description, double min, double max, double step)
obs_property_group_type
EXPORT enum obs_group_type obs_property_group_type(obs_property_t *p)
OBS_PROPERTY_PATH
@ OBS_PROPERTY_PATH
Definition: obs-properties.h:51
obs_properties_add_path
EXPORT obs_property_t * obs_properties_add_path(obs_properties_t *props, const char *name, const char *description, enum obs_path_type type, const char *filter, const char *default_path)
obs_property_list_insert_int
EXPORT void obs_property_list_insert_int(obs_property_t *p, size_t idx, const char *name, long long val)
obs_property_list_item_string
EXPORT const char * obs_property_list_item_string(obs_property_t *p, size_t idx)
obs_property_next
EXPORT bool obs_property_next(obs_property_t **p)
obs_path_type
obs_path_type
Definition: obs-properties.h:80
obs_proprety_text_type
OBS_DEPRECATED EXPORT enum obs_text_type obs_proprety_text_type(obs_property_t *p)
obs_property_int_min
EXPORT int obs_property_int_min(obs_property_t *p)
obs_properties_add_color
EXPORT obs_property_t * obs_properties_add_color(obs_properties_t *props, const char *name, const char *description)
obs_properties_create
EXPORT obs_properties_t * obs_properties_create(void)
OBS_PROPERTY_BOOL
@ OBS_PROPERTY_BOOL
Definition: obs-properties.h:47
OBS_EDITABLE_LIST_TYPE_STRINGS
@ OBS_EDITABLE_LIST_TYPE_STRINGS
Definition: obs-properties.h:75
obs_property_list_add_int
EXPORT size_t obs_property_list_add_int(obs_property_t *p, const char *name, long long val)
obs_property_frame_rate_fps_range_max
EXPORT struct media_frames_per_second obs_property_frame_rate_fps_range_max(obs_property_t *p, size_t idx)
obs_property_modified2_t
bool(* obs_property_modified2_t)(void *priv, obs_properties_t *props, obs_property_t *property, obs_data_t *settings)
Definition: obs-properties.h:275
obs_number_type
obs_number_type
Definition: obs-properties.h:92
OBS_TEXT_DEFAULT
@ OBS_TEXT_DEFAULT
Definition: obs-properties.h:87
obs_property_button_clicked
EXPORT bool obs_property_button_clicked(obs_property_t *p, void *obj)
obs_properties_add_font
EXPORT obs_property_t * obs_properties_add_font(obs_properties_t *props, const char *name, const char *description)
obs_properties_t
struct obs_properties obs_properties_t
Definition: obs-properties.h:110
obs_property_modified_t
bool(* obs_property_modified_t)(obs_properties_t *props, obs_property_t *property, obs_data_t *settings)
Definition: obs-properties.h:272
obs_property_list_item_count
EXPORT size_t obs_property_list_item_count(obs_property_t *p)
obs_property_list_item_disabled
EXPORT bool obs_property_list_item_disabled(obs_property_t *p, size_t idx)
obs_property_editable_list_filter
EXPORT const char * obs_property_editable_list_filter(obs_property_t *p)
obs_properties_add_float
EXPORT obs_property_t * obs_properties_add_float(obs_properties_t *props, const char *name, const char *description, double min, double max, double step)
obs_property_editable_list_type
EXPORT enum obs_editable_list_type obs_property_editable_list_type(obs_property_t *p)
obs_properties_remove_by_name
EXPORT void obs_properties_remove_by_name(obs_properties_t *props, const char *property)
OBS_PROPERTY_COLOR
@ OBS_PROPERTY_COLOR
Definition: obs-properties.h:53
OBS_PROPERTY_INT
@ OBS_PROPERTY_INT
Definition: obs-properties.h:48
OBS_PATH_DIRECTORY
@ OBS_PATH_DIRECTORY
Definition: obs-properties.h:83
obs_property_frame_rate_clear
EXPORT void obs_property_frame_rate_clear(obs_property_t *p)
obs_properties_get
EXPORT obs_property_t * obs_properties_get(obs_properties_t *props, const char *property)
OBS_PATH_FILE_SAVE
@ OBS_PATH_FILE_SAVE
Definition: obs-properties.h:82
obs_property_frame_rate_fps_ranges_clear
EXPORT void obs_property_frame_rate_fps_ranges_clear(obs_property_t *p)
obs_property_frame_rate_options_clear
EXPORT void obs_property_frame_rate_options_clear(obs_property_t *p)
obs_property_list_insert_float
EXPORT void obs_property_list_insert_float(obs_property_t *p, size_t idx, const char *name, double val)
obs_properties_set_flags
EXPORT void obs_properties_set_flags(obs_properties_t *props, uint32_t flags)
obs_property_long_description
EXPORT const char * obs_property_long_description(obs_property_t *p)
obs_property_description
EXPORT const char * obs_property_description(obs_property_t *p)
OBS_EDITABLE_LIST_TYPE_FILES_AND_URLS
@ OBS_EDITABLE_LIST_TYPE_FILES_AND_URLS
Definition: obs-properties.h:77
obs_property_frame_rate_fps_range_add
EXPORT size_t obs_property_frame_rate_fps_range_add(obs_property_t *p, struct media_frames_per_second min, struct media_frames_per_second max)
obs_properties_destroy
EXPORT void obs_properties_destroy(obs_properties_t *props)
obs_property_text_monospace
EXPORT enum obs_text_type obs_property_text_monospace(obs_property_t *p)
obs_property_list_format
EXPORT enum obs_combo_format obs_property_list_format(obs_property_t *p)
obs_property_visible
EXPORT bool obs_property_visible(obs_property_t *p)
obs_property_type
obs_property_type
Definition: obs-properties.h:45
OBS_GROUP_NORMAL
@ OBS_GROUP_NORMAL
Definition: obs-properties.h:99
OBS_TEXT_PASSWORD
@ OBS_TEXT_PASSWORD
Definition: obs-properties.h:88
obs_property_int_set_limits
EXPORT void obs_property_int_set_limits(obs_property_t *p, int min, int max, int step)
obs_property_frame_rate_option_insert
EXPORT void obs_property_frame_rate_option_insert(obs_property_t *p, size_t idx, const char *name, const char *description)
obs_combo_type
obs_combo_type
Definition: obs-properties.h:68
obs_property_int_suffix
EXPORT const char * obs_property_int_suffix(obs_property_t *p)
obs_properties_add_list
EXPORT obs_property_t * obs_properties_add_list(obs_properties_t *props, const char *name, const char *description, enum obs_combo_type type, enum obs_combo_format format)
OBS_COMBO_FORMAT_INT
@ OBS_COMBO_FORMAT_INT
Definition: obs-properties.h:63
OBS_DEPRECATED
#define OBS_DEPRECATED
Definition: c99defs.h:30
obs_property_frame_rate_fps_range_min
EXPORT struct media_frames_per_second obs_property_frame_rate_fps_range_min(obs_property_t *p, size_t idx)
OBS_NUMBER_SCROLLER
@ OBS_NUMBER_SCROLLER
Definition: obs-properties.h:93
obs_property_t
struct obs_property obs_property_t
Definition: obs-properties.h:111
OBS_PATH_FILE
@ OBS_PATH_FILE
Definition: obs-properties.h:81
obs_properties_add_frame_rate
EXPORT obs_property_t * obs_properties_add_frame_rate(obs_properties_t *props, const char *name, const char *description)
obs_property_frame_rate_option_add
EXPORT size_t obs_property_frame_rate_option_add(obs_property_t *p, const char *name, const char *description)
obs_property_frame_rate_option_description
EXPORT const char * obs_property_frame_rate_option_description(obs_property_t *p, size_t idx)
obs_properties_add_button2
EXPORT obs_property_t * obs_properties_add_button2(obs_properties_t *props, const char *name, const char *text, obs_property_clicked_t callback, void *priv)
obs_property_set_long_description
EXPORT void obs_property_set_long_description(obs_property_t *p, const char *long_description)
obs_property_list_add_string
EXPORT size_t obs_property_list_add_string(obs_property_t *p, const char *name, const char *val)
obs_properties_apply_settings
EXPORT void obs_properties_apply_settings(obs_properties_t *props, obs_data_t *settings)
obs_property_int_max
EXPORT int obs_property_int_max(obs_property_t *p)
obs_property_frame_rate_options_count
EXPORT size_t obs_property_frame_rate_options_count(obs_property_t *p)
obs_text_type
obs_text_type
Definition: obs-properties.h:86
obs_property_list_item_disable
EXPORT void obs_property_list_item_disable(obs_property_t *p, size_t idx, bool disabled)
OBS_PROPERTY_FONT
@ OBS_PROPERTY_FONT
Definition: obs-properties.h:55
obs_property_int_step
EXPORT int obs_property_int_step(obs_property_t *p)
obs_properties_first
EXPORT obs_property_t * obs_properties_first(obs_properties_t *props)
obs_property_list_clear
EXPORT void obs_property_list_clear(obs_property_t *p)
obs_property_list_type
EXPORT enum obs_combo_type obs_property_list_type(obs_property_t *p)
OBS_COMBO_TYPE_INVALID
@ OBS_COMBO_TYPE_INVALID
Definition: obs-properties.h:69
OBS_PROPERTY_EDITABLE_LIST
@ OBS_PROPERTY_EDITABLE_LIST
Definition: obs-properties.h:56