OpenBroadcaster Documentation

public category_delete (

)

Delete a media category. Requires 'manage_media_settings' permission.

Parameters

id

API Route DELETE /api/v2/metadata/categories/(:id:)

public category_get (

)

Retrieve a media category by ID.

Parameters

id

Returns [id, name, is_default]

API Route GET /api/v2/metadata/categories/(:id:)

public category_list (

)

Return filtered and ordered media categories.

Parameters

`filters`
`orderby`
`orderdesc`
`limit`
`offset`

Returns categories

API Route GET /api/v2/metadata/categories

public category_save (

)

Save a media category. Requires 'manage_media_settings' permission.

Parameters

`id`	Optional when editing already existing category.
`name`
`default`	Set as default category for new media.

API Route POST /api/v2/metadata/categories

public country_list (

)

List all media countries.

Returns countries

API Route GET /api/v2/metadata/countries

public genre_delete (

)

Delete a media genre. Requires 'manage_media_settings' permission.

Parameters

id

API Route DELETE /api/v2/metadata/genres/(:id:)

public genre_get (

)

Return a genre by ID.

Parameters

id

Returns [id, name, description, media_category_id]

API Route GET /api/v2/metadata/genres/(:id:)

public genre_list (

)

Return filtered and ordered media genres.

Parameters

`filters`
`orderby`
`orderdesc`
`limit`
`offset`

Returns genres

API Route GET /api/v2/metadata/genres

public genre_save (

)

Save a media genre. Requires 'manage_media_settings' permission.

Parameters

`id`	Optional when updating a pre-existing genre.
`name`
`description`
`media_category_id`
`default`	Set as default genre for new media.

API Route POST /api/v2/metadata/genres

public language_list (

)

List all media languages.

Returns languages.

API Route GET /api/v2/metadata/languages

public media_get_fields (

)

List all media core metadata fields defined in the settings table.

Returns metadata_fields

API Route GET /api/v2/metadata/core

public media_metadata_fields (

)

List all media metadata fields.

Returns metadata_fields

API Route GET /api/v2/metadata

public media_required_fields (

)

Update required metadata fields for media. Requires 'manage_media_settings' permission.

Parameters

`artist`
`album`
`year`
`category_id`
`country_id`
`language_id`
`comments`
`dynamic_content_default`
`dynamic_content_hidden`

API Route PUT /api/v2/metadata/required

public metadata_delete (

)

Delete a metadata field. Requires 'manage_media_settings' permission.

Parameters

id

API Route DELETE /api/v2/metadata/(:id:)

public metadata_order (

)

Change metadata field order. Requires 'manage_media_settings' permission.

Parameters

order

API Route PUT /api/v2/metadata/order

public metadata_save (

)

Add or edit a metadata field. Requires 'manage_media_settings' permission.

Parameters

`id`	Optional when editing already existing metadata field.
`name`
`description`
`type`	Text (single or multiple lines), boolean, dropdown, tags.
`select_options`	Options in dropdown when selected as type.
`default`
`tag_suggestions`

API Route POST /api/v2/metadata

public metadata_tag_search (

)

Search metadata field for tags from the suggested tags saved.

Parameters

`id`
`search`

Returns [tag]

API Route GET /api/v2/metadata/tags

`Metadata`

`Controller`