Core API Object Referenceï
- Sources (obs_source_t)
obs_source_tobs_weak_source_t- Source Definition Structure (obs_source_info)
obs_source_infoidversiontypeoutput_flagsget_namecreatedestroyget_widthget_heightget_defaultsget_defaults2get_propertiesget_properties2updateactivatedeactivateshowhidevideo_tickvideo_renderfilter_videofilter_audioenum_active_sourcessaveloadmouse_clickmouse_movemouse_wheelfocuskey_clickfilter_addfilter_removetype_datafree_type_dataaudio_renderenum_all_sourcestransition_starttransition_stopicon_typeget_dark_iconget_light_iconmedia_play_pausemedia_restartmedia_stopmedia_nextmedia_previousmedia_get_durationmedia_get_timemedia_set_timemedia_get_statemissing_filesvideo_get_color_space
- Common Source Signals
- Source-specific Signals
- Source-specific Procedures
- General Source Functions
obs_register_source()obs_source_get_display_name()obs_source_create()obs_source_create_private()obs_source_duplicate()obs_source_get_ref()obs_source_release()obs_source_get_weak_source()obs_weak_source_get_source()obs_weak_source_addref()obs_weak_source_release()obs_source_remove()obs_source_removed()obs_source_is_hidden()obs_source_set_hidden()obs_source_get_output_flags()obs_get_source_output_flags()obs_get_source_defaults()obs_source_properties()obs_get_source_properties()obs_source_configurable()obs_is_source_configurable()obs_source_update()obs_source_reset_settings()obs_source_video_render()obs_source_get_width()obs_source_get_height()obs_source_get_color_space()obs_source_get_texcoords_centered()obs_source_get_settings()obs_source_get_name()obs_source_get_uuid()obs_source_set_name()obs_source_get_type()obs_source_is_scene()obs_source_is_group()obs_source_get_id()obs_source_get_unversioned_id()obs_source_get_signal_handler()obs_source_get_proc_handler()obs_source_set_volume()obs_source_get_volume()obs_source_muted()obs_source_set_muted()obs_source_get_speaker_layout()obs_source_set_balance_value()obs_source_get_balance_value()obs_source_set_sync_offset()obs_source_get_sync_offset()obs_source_set_audio_mixers()obs_source_get_audio_mixers()obs_source_set_monitoring_type()obs_source_get_monitoring_type()obs_source_set_monitoring_enabled()obs_source_get_monitoring_enabled()obs_source_set_audio_active()obs_source_audio_active()obs_source_enum_active_sources()obs_source_enum_active_tree()obs_source_push_to_mute_enabled()obs_source_enable_push_to_mute()obs_source_get_push_to_mute_delay()obs_source_set_push_to_mute_delay()obs_source_push_to_talk_enabled()obs_source_enable_push_to_talk()obs_source_get_push_to_talk_delay()obs_source_set_push_to_talk_delay()obs_source_active()obs_source_showing()obs_source_inc_showing()obs_source_dec_showing()obs_source_set_flags()obs_source_get_flags()obs_source_enum_filters()obs_source_get_filter_by_name()obs_source_copy_filters()obs_source_copy_single_filter()obs_source_filter_count()obs_source_backup_filters()obs_source_restore_filters()obs_source_enabled()obs_source_set_enabled()obs_source_add_audio_capture_callback()obs_source_remove_audio_capture_callback()obs_source_set_deinterlace_mode()obs_source_get_deinterlace_mode()obs_source_set_deinterlace_field_order()obs_source_get_deinterlace_field_order()obs_source_get_private_settings()obs_source_send_mouse_click()obs_source_send_mouse_move()obs_source_send_mouse_wheel()obs_source_send_focus()obs_source_send_key_click()obs_source_get_icon_type()obs_source_get_dark_icon()obs_source_get_light_icon()obs_source_media_play_pause()obs_source_media_restart()obs_source_media_stop()obs_source_media_next()obs_source_media_previous()obs_source_media_get_duration()obs_source_media_get_time()obs_source_media_set_time()obs_source_media_get_state()obs_source_media_started()obs_source_media_ended()obs_source_get_canvas()
- Functions used by sources
- Filters
- Functions used by filters
- Transitions
obs_transition_get_source()obs_transition_clear()obs_transition_get_active_source()obs_transition_start()obs_transition_is_active()obs_transition_set_size()obs_transition_get_size()obs_transition_set_scale_type()obs_transition_get_scale_type()obs_transition_set_alignment()obs_transition_get_alignment()
- Functions used by transitions
- Scenes (obs_scene_t)
obs_scene_tobs_sceneitem_t- Scene Item Transform Structure (obs_transform_info)
- Scene Item Crop Structure (obs_sceneitem_crop)
- Scene Item Order Info Structure (*obs_sceneitem_order_info)
- Scene Signals
- General Scene Functions
obs_scene_create()obs_scene_create_private()obs_scene_duplicate()obs_scene_get_ref()obs_scene_release()obs_scene_add()obs_scene_get_source()obs_scene_from_source()obs_scene_find_source()obs_scene_find_source_recursive()obs_scene_find_sceneitem_by_id()obs_scene_enum_items()obs_scene_reorder_items()obs_scene_reorder_items2()obs_scene_prune_sources()
- Scene Item Functions
obs_sceneitem_addref()obs_sceneitem_release()obs_sceneitem_remove()obs_sceneitem_get_scene()obs_sceneitem_get_source()obs_sceneitem_set_id()obs_sceneitem_get_id()obs_scene_save_transform_states()obs_scene_load_transform_states()obs_sceneitem_set_pos()obs_sceneitem_get_pos()obs_sceneitem_set_rot()obs_sceneitem_get_rot()obs_sceneitem_set_scale()obs_sceneitem_get_scale()obs_sceneitem_set_alignment()obs_sceneitem_get_alignment()obs_sceneitem_set_order()obs_sceneitem_set_order_position()obs_sceneitem_get_order_position()obs_sceneitem_set_bounds_type()obs_sceneitem_get_bounds_type()obs_sceneitem_set_bounds_alignment()obs_sceneitem_get_bounds_alignment()obs_sceneitem_set_bounds()obs_sceneitem_get_bounds()obs_sceneitem_set_info2()obs_sceneitem_get_info2()obs_sceneitem_get_draw_transform()obs_sceneitem_get_box_transform()obs_sceneitem_select()obs_sceneitem_selected()obs_sceneitem_set_visible()obs_sceneitem_visible()obs_sceneitem_set_locked()obs_sceneitem_locked()obs_sceneitem_set_crop()obs_sceneitem_get_crop()obs_sceneitem_set_scale_filter()obs_sceneitem_get_scale_filter()obs_sceneitem_set_blending_method()obs_sceneitem_get_blending_method()obs_sceneitem_set_blending_mode()obs_sceneitem_get_blending_mode()obs_sceneitem_defer_update_begin()obs_sceneitem_defer_update_end()obs_sceneitem_get_private_settings()obs_sceneitem_set_transition()obs_sceneitem_get_transition()obs_sceneitem_set_transition_duration()obs_sceneitem_get_transition_duration()obs_sceneitem_do_transition()
- Scene Item Group Functions
obs_scene_add_group()obs_scene_add_group2()obs_scene_insert_group()obs_scene_insert_group2()obs_scene_get_group()obs_group_from_source()obs_group_or_scene_from_source()obs_sceneitem_is_group()obs_sceneitem_group_get_scene()obs_sceneitem_group_ungroup()obs_sceneitem_group_ungroup2()obs_sceneitem_group_add_item()obs_sceneitem_group_remove_item()obs_sceneitem_get_group()obs_sceneitem_group_enum_items()obs_sceneitem_defer_group_resize_begin()obs_sceneitem_defer_group_resize_end()
- Outputs (obs_output_t)
obs_output_tobs_weak_output_t- Output Definition Structure (obs_output_info)
obs_output_infoidflagsget_namecreatedestroystartstopraw_videoraw_audioraw_audio2encoded_packetupdateget_defaultsget_defaults2get_propertiesget_properties2unused1get_total_bytesget_dropped_framestype_datafree_type_dataget_congestionget_connect_time_msencoded_video_codecsencoded_audio_codecsprotocols
- Output Signals
- General Output Functions
obs_register_output()obs_output_get_display_name()obs_output_create()obs_output_get_ref()obs_output_release()obs_output_get_weak_output()obs_weak_output_get_output()obs_weak_output_addref()obs_weak_output_release()obs_weak_output_references_output()obs_output_get_name()obs_output_get_id()obs_output_start()obs_output_stop()obs_output_set_delay()obs_output_get_delay()obs_output_get_active_delay()obs_output_force_stop()obs_output_active()obs_output_defaults()obs_output_properties()obs_get_output_properties()obs_output_update()obs_output_can_pause()obs_output_pause()obs_output_paused()obs_output_get_settings()obs_output_get_signal_handler()obs_output_get_proc_handler()obs_output_set_media()obs_output_video()obs_output_audio()obs_output_set_mixer()obs_output_get_mixer()obs_output_set_mixers()obs_output_get_mixers()obs_output_set_video_encoder()obs_output_set_audio_encoder()obs_output_get_video_encoder()obs_output_get_audio_encoder()obs_output_set_service()obs_output_get_service()obs_output_set_reconnect_settings()obs_output_get_total_bytes()obs_output_get_frames_dropped()obs_output_get_total_frames()obs_output_set_preferred_size()obs_output_get_width()obs_output_get_height()obs_output_output_caption_text1()obs_output_output_caption_text2()obs_output_get_congestion()obs_output_get_connect_time_ms()obs_output_reconnecting()obs_output_get_supported_video_codecs()obs_get_output_supported_video_codecs()obs_output_get_supported_audio_codecs()obs_get_output_supported_audio_codecs()obs_output_get_flags()obs_get_output_flags()obs_output_get_protocols()obs_is_output_protocol_registered()obs_enum_output_protocols()obs_enum_output_types_with_protocol()obs_output_set_reconnect_callback()
- Functions used by outputs
obs_output_set_last_error()obs_output_get_last_error()obs_output_set_video_conversion()obs_output_get_video_conversion()obs_output_set_audio_conversion()obs_output_can_begin_data_capture()obs_output_initialize_encoders()obs_output_begin_data_capture()obs_output_end_data_capture()obs_output_signal_stop()obs_output_get_pause_offset()
- Encoders (obs_encoder_t)
obs_encoder_tobs_weak_encoder_t- Encoder Definition Structure (obs_encoder_info)
- Encoder Packet Structure (encoder_packet)
- Raw Frame Data Structure (encoder_frame)
- Encoder Region of Interest Structure (obs_encoder_roi)
- General Encoder Functions
obs_register_encoder()obs_encoder_get_display_name()obs_video_encoder_create()obs_audio_encoder_create()obs_encoder_get_ref()obs_encoder_release()obs_encoder_get_weak_encoder()obs_weak_encoder_get_encoder()obs_weak_encoder_addref()obs_weak_encoder_release()obs_encoder_set_name()obs_encoder_get_name()obs_encoder_get_codec()obs_get_encoder_codec()obs_encoder_get_type()obs_get_encoder_type()obs_encoder_set_scaled_size()obs_encoder_scaling_enabled()obs_encoder_get_width()obs_encoder_get_height()obs_encoder_get_sample_rate()obs_encoder_get_frame_size()obs_encoder_get_mixer_index()obs_encoder_set_preferred_video_format()obs_encoder_get_preferred_video_format()obs_encoder_defaults()obs_encoder_get_defaults()obs_encoder_properties()obs_get_encoder_properties()obs_encoder_update()obs_encoder_get_settings()obs_encoder_get_signal_handler()obs_encoder_get_proc_handler()obs_encoder_get_extra_data()obs_encoder_set_video()obs_encoder_set_audio()obs_encoder_video()obs_encoder_parent_video()obs_encoder_audio()obs_encoder_active()obs_encoder_add_roi()obs_encoder_has_roi()obs_encoder_clear_roi()obs_encoder_enum_roi()obs_encoder_get_roi_increment()obs_encoder_get_priming_samples()
- Functions used by encoders
- Services (obs_service_t)
obs_service_tobs_weak_service_t- Service Definition Structure
obs_service_infoidget_namecreatedestroyget_defaultsget_defaults2get_propertiesget_properties2updateinitializeget_urlget_keyget_usernameget_passwordapply_encoder_settingstype_datafree_type_dataget_output_typeget_supported_video_codecsget_supported_audio_codecsget_protocolget_connect_infocan_try_to_connect
- General Service Functions
obs_register_service()obs_service_get_display_name()obs_service_create()obs_service_get_ref()obs_service_release()obs_service_get_weak_service()obs_weak_service_get_service()obs_weak_service_addref()obs_weak_service_release()obs_service_get_name()obs_service_defaults()obs_service_properties()obs_get_service_properties()obs_service_get_settings()obs_service_update()obs_service_apply_encoder_settings()obs_service_get_supported_video_codecs()obs_service_get_supported_audio_codecs()obs_service_get_protocol()obs_service_get_preferred_output_type()obs_service_get_connect_info()obs_service_can_try_to_connect()
- Data Settings (obs_data_t)
obs_data_tobs_data_array_t- General Functions
obs_data_create()obs_data_create_from_json()obs_data_create_from_json_file()obs_data_create_from_json_file_safe()obs_data_addref()obs_data_release()obs_data_get_json()obs_data_get_json_with_defaults()obs_data_get_json_pretty()obs_data_get_json_pretty_with_defaults()obs_data_get_last_json()obs_data_save_json()obs_data_save_json_safe()obs_data_apply()obs_data_erase()obs_data_clear()
- Set Functions
- Get Functions
- Default Value Functions
obs_data_get_defaults()obs_data_set_default_string()obs_data_get_default_string()obs_data_set_default_int()obs_data_get_default_int()obs_data_set_default_double()obs_data_get_default_double()obs_data_set_default_bool()obs_data_get_default_bool()obs_data_set_default_obj()obs_data_get_default_obj()obs_data_set_default_array()obs_data_get_default_array()
- Autoselect Functions
obs_data_set_autoselect_string()obs_data_get_autoselect_string()obs_data_set_autoselect_int()obs_data_get_autoselect_int()obs_data_set_autoselect_double()obs_data_get_autoselect_double()obs_data_set_autoselect_bool()obs_data_get_autoselect_bool()obs_data_set_autoselect_obj()obs_data_get_autoselect_obj()obs_data_set_autoselect_array()obs_data_get_autoselect_array()
- Array Functions
- Properties (obs_properties_t)
obs_properties_tobs_property_t- General Functions
- Property Object Functions
obs_properties_add_bool()obs_properties_add_int()obs_properties_add_float()obs_properties_add_int_slider()obs_properties_add_float_slider()obs_properties_add_text()obs_properties_add_path()obs_properties_add_list()obs_properties_add_color()obs_properties_add_color_alpha()obs_properties_add_button()obs_properties_add_button2()obs_properties_add_font()obs_properties_add_editable_list()obs_properties_add_frame_rate()obs_properties_add_group()
- Property Enumeration Functions
obs_properties_first()obs_properties_get()obs_property_next()obs_property_name()obs_property_description()obs_property_long_description()obs_property_get_type()obs_property_enabled()obs_property_visible()obs_property_int_min()obs_property_int_max()obs_property_int_step()obs_property_int_type()obs_property_int_suffix()obs_property_float_min()obs_property_float_max()obs_property_float_step()obs_property_float_type()obs_property_float_suffix()obs_property_text_type()obs_property_text_monospace()obs_property_text_info_type()obs_property_text_info_word_wrap()obs_property_path_type()obs_property_path_filter()obs_property_path_default_path()obs_property_list_type()obs_property_list_format()obs_property_list_item_disabled()obs_property_list_item_count()obs_property_list_item_name()obs_property_list_item_string()obs_property_list_item_int()obs_property_list_item_float()obs_property_editable_list_type()obs_property_editable_list_filter()obs_property_editable_list_default_path()obs_property_frame_rate_options_count()obs_property_frame_rate_option_name()obs_property_frame_rate_option_description()obs_property_frame_rate_fps_ranges_count()obs_property_frame_rate_fps_range_min()obs_property_frame_rate_fps_range_max()obs_property_button_type()obs_property_button_url()obs_property_group_type()obs_property_group_content()
- Property Modification Functions
obs_property_set_modified_callback()obs_property_set_modified_callback2()obs_property_modified()obs_property_button_clicked()obs_property_set_visible()obs_property_set_enabled()obs_property_set_description()obs_property_set_long_description()obs_property_int_set_limits()obs_property_float_set_limits()obs_property_int_set_suffix()obs_property_float_set_suffix()obs_property_text_set_monospace()obs_property_text_set_info_type()obs_property_text_set_info_word_wrap()obs_property_list_clear()obs_property_list_add_string()obs_property_list_add_int()obs_property_list_add_float()obs_property_list_insert_string()obs_property_list_insert_int()obs_property_list_insert_float()obs_property_list_item_disable()obs_property_list_item_remove()obs_property_frame_rate_option_add()obs_property_frame_rate_fps_range_add()obs_property_frame_rate_clear()obs_property_frame_rate_options_clear()obs_property_frame_rate_fps_ranges_clear()obs_property_frame_rate_option_insert()obs_property_frame_rate_fps_range_insert()obs_property_button_set_type()obs_property_button_set_url()
