Service API Reference (obs_service_t)

Services are custom implementations of streaming services, which are used with outputs that stream. For example, you could have a custom implementation for streaming to Twitch, and another for YouTube to allow the ability to log in and use their APIs to do things such as get the RTMP servers or control the channel. The libobs/obs-service.h file is the dedicated header for implementing services.

(Author’s note: the service API is incomplete as of this writing)

type obs_service_t

A reference-counted service object.

type obs_weak_service_t

A weak reference to a service object.

#include <obs.h>

Service Definition Structure

struct obs_service_info

Service definition structure.

const char *obs_service_info.id

Unique string identifier for the service (required).

const char *(*obs_service_info.get_name)(void *type_data)

Get the translated name of the service type.

Param type_data

The type_data variable of this structure

Return

The translated name of the service type

void *(*obs_service_info.create)(obs_data_t *settings, obs_service_t *service)

Creates the implementation data for the service.

Param settings

Settings to initialize the service with

Param service

Source that this data is associated with

Return

The implementation data associated with this service

void (*obs_service_info.destroy)(void *data)

Destroys the implementation data for the service.

void (*obs_service_info.get_defaults)(obs_data_t *settings)
void (*obs_service_info.get_defaults2)(void *type_data, obs_data_t *settings)

Sets the default settings for this service.

Param settings

Default settings. Call obs_data_set_default* functions on this object to set default setting values

obs_properties_t *(*obs_service_info.get_properties)(void *data)
obs_properties_t *(*obs_service_info.get_properties2)(void *data, void *type_data)

Gets the property information of this service.

(Optional)

Return

The properties of the service

void (*obs_service_info.update)(void *data, obs_data_t *settings)

Updates the settings for this service.

(Optional)

Param settings

New settings for this service

bool (*obs_service_info.initialize)(void *data, obs_output_t *output)

Called when getting ready to start up an output, before the encoders and output are initialized.

(Optional)

Param output

Output context to use this service with

Return

true to allow the output to start up, false to prevent output from starting up

const char *(*obs_service_info.get_url)(void *data)
Return

The stream URL

const char *(*obs_service_info.get_key)(void *data)
Return

The stream key

const char *(*obs_service_info.get_username)(void *data)

(Optional)

Return

The username

const char *(*obs_service_info.get_password)(void *data)

(Optional)

Return

The password

void (*obs_service_info.apply_encoder_settings)(void *data, obs_data_t *video_encoder_settings, obs_data_t *audio_encoder_settings)

This function is called to apply custom encoder settings specific to this service. For example, if a service requires a specific keyframe interval, or has a bitrate limit, the settings for the video and audio encoders can be optionally modified if the front-end optionally calls obs_service_apply_encoder_settings().

(Optional)

Param video_encoder_settings

The audio encoder settings to change

Param audio_encoder_settings

The video encoder settings to change

void *obs_service_info.type_data
void (*obs_service_info.free_type_data)(void *type_data)

Private data associated with this entry. Note that this is not the same as the implementation data; this is used to differentiate between two different types if the same callbacks are used for more than one different type.

(Optional)

const char *(*obs_service_info.get_output_type)(void *data)

(Optional)

Return

The output type that should be used with this service

const char **(*get_supported_video_codecs)(void *data)

(Optional)

Return

A string pointer array of the supported video codecs, should be stored by the plugin so the caller does not need to free the data manually (typically best to use strlist_split to generate this)

General Service Functions

void obs_register_service(struct obs_service_info *info)

Registers a service type. Typically used in obs_module_load() or in the program’s initialization phase.

const char *obs_service_get_display_name(const char *id)

Calls the obs_service_info.get_name callback to get the translated display name of a service type.

Parameters

  • id – The service type string identifier

Returns

The translated display name of a service type

obs_service_t *obs_service_create(const char *id, const char *name, obs_data_t *settings, obs_data_t *hotkey_data)

Creates a service with the specified settings.

The “service” context is used for encoding video/audio data. Use obs_service_release to release it.

Parameters

  • id – The service type string identifier

  • name – The desired name of the service. If this is not unique, it will be made to be unique

  • settings – The settings for the service, or NULL if none

  • hotkey_data – Saved hotkey data for the service, or NULL if none

Returns

A reference to the newly created service, or NULL if failed

void obs_service_addref(obs_service_t *service)

Adds a reference to a service.

Deprecated since version 27.2.0: Use obs_service_get_ref() instead.

obs_service_t *obs_service_get_ref(obs_service_t *service)

Returns an incremented reference if still valid, otherwise returns NULL.

void obs_service_release(obs_service_t *service)

Releases a reference to a service. When the last reference is released, the service is destroyed.

obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service)
obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak)

These functions are used to get a weak reference from a strong service reference, or a strong service reference from a weak reference. If the service is destroyed, obs_weak_service_get_service will return NULL.

void obs_weak_service_addref(obs_weak_service_t *weak)
void obs_weak_service_release(obs_weak_service_t *weak)

Adds/releases a weak reference to a service.

const char *obs_service_get_name(const obs_service_t *service)
Returns

The name of the service

obs_data_t *obs_service_defaults(const char *id)
Returns

An incremented reference to the service’s default settings

obs_properties_t *obs_service_properties(const obs_service_t *service)
obs_properties_t *obs_get_service_properties(const char *id)

Use these functions to get the properties of a service or service type. Properties are optionally used (if desired) to automatically generate user interface widgets to allow users to update settings.

Returns

The properties list for a specific existing service. Free with obs_properties_destroy()

obs_data_t *obs_service_get_settings(const obs_service_t *service)
Returns

An incremented reference to the service’s settings

void obs_service_update(obs_service_t *service, obs_data_t *settings)

Updates the settings for this service context.

const char *obs_service_get_url(const obs_service_t *service)
Returns

The URL currently used for this service

const char *obs_service_get_key(const obs_service_t *service)
Returns

Stream key (if any) currently used for this service

const char *obs_service_get_username(const obs_service_t *service)
Returns

User name (if any) currently used for this service

const char *obs_service_get_password(const obs_service_t *service)
Returns

Password (if any) currently used for this service

void obs_service_apply_encoder_settings(obs_service_t *service, obs_data_t *video_encoder_settings, obs_data_t *audio_encoder_settings)

Applies service-specific video encoder settings.

Parameters

  • video_encoder_settings – Video encoder settings. Can be NULL

  • audio_encoder_settings – Audio encoder settings. Can be NULL

const char **obs_service_get_supported_video_codecs(const obs_service_t *service)
Returns

An array of string pointers containing the supported codecs for the service, terminated with a NULL pointer. Does not need to be freed