controllers / settings.phpSettings
Controller
Manages media settings. Note that this specifically does NOT manage user-related and global settings in the settings table. User settings are managed in the Accounts controller, and there is no (as of 2020-02-25) specific controller for managing global settings.
public
category_delete
(
)
public
category_delete
(
)
Delete a media category. Requires 'manage_media_settings' permission.
id |
public
category_get
(
)
public
category_get
(
)
Retrieve a media category by ID.
id |
[id, name, is_default]
public
category_list
(
)
public
category_list
(
)
Return filtered and ordered media categories.
filters |
|
orderby |
|
orderdesc |
|
limit |
|
offset |
categories
public
category_save
(
)
public
category_save
(
)
Save a media category. Requires 'manage_media_settings' permission.
id |
Optional when editing already existing category. |
name |
|
default |
Set as default category for new media. |
public
country_list
(
)
public
country_list
(
)
List all media countries.
countries
public
genre_delete
(
)
public
genre_delete
(
)
Delete a media genre. Requires 'manage_media_settings' permission.
id |
public
genre_get
(
)
public
genre_get
(
)
Return a genre by ID.
id |
[id, name, description, media_category_id]
public
genre_list
(
)
public
genre_list
(
)
Return filtered and ordered media genres.
filters |
|
orderby |
|
orderdesc |
|
limit |
|
offset |
genres
public
genre_save
(
)
public
genre_save
(
)
Save a media genre. Requires 'manage_media_settings' permission.
id |
Optional when updating a pre-existing genre. |
name |
|
description |
|
media_category_id |
|
default |
Set as default genre for new media. |
public
get_ob_version
(
)
public
get_ob_version
(
)
Return OpenBroadcaster version information.
version
public
language_list
(
)
public
language_list
(
)
List all media languages.
languages.
public
media_get_fields
(
)
public
media_get_fields
(
)
List all media core metadata fields defined in the settings table.
metadata_fields
public
media_metadata_fields
(
)
public
media_metadata_fields
(
)
List all media metadata fields.
metadata_fields
public
media_required_fields
(
)
public
media_required_fields
(
)
Update required metadata fields for media. Requires 'manage_media_settings' permission.
artist |
|
album |
|
year |
|
category_id |
|
country_id |
|
language_id |
|
comments |
|
dynamic_content_default |
|
dynamic_content_hidden |
public
metadata_delete
(
)
public
metadata_delete
(
)
Delete a metadata field. Requires 'manage_media_settings' permission.
id |
public
metadata_order
(
)
public
metadata_order
(
)
Change metadata field order. Requires 'manage_media_settings' permission.
order |
public
metadata_save
(
)
public
metadata_save
(
)
Add or edit a metadata field. Requires 'manage_media_settings' permission.
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 |
public
metadata_tag_search
(
)
public
metadata_tag_search
(
)
Search metadata field for tags from the suggested tags saved.
id |
|
search |
[tag]