Video API, gRPC: StylePresetService.Create
Creates a new style preset in the specified channel with the provided visual settings.
Style presets define the appearance of players, including colors, spacing, borders, and widgets.
gRPC request
rpc Create (CreateStylePresetRequest) returns (operation.Operation)
CreateStylePresetRequest
{
"channel_id": "string",
"title": "string",
"background_color": "string",
"widget_text_color_primary": "string",
"widget_text_color_secondary": "string",
"widget_accent_color": "string",
"widget_block_gap": "int64",
"widget_block_separator_color": "string",
"player_border_radius": "int64",
"player_color": "string",
"playlist_selected_item_background_color": "string",
"playlist_item_border_radius": "int64",
"playlist_item_gap": "int64",
"playlist_location": "WidgetLocation",
"right_widgets": [
{
// Includes only one of the fields `summarization`, `description`
"summarization": "Summarization",
"description": "Description"
// end of the list of possible fields
}
],
"bottom_widgets": [
{
// Includes only one of the fields `summarization`, `description`
"summarization": "Summarization",
"description": "Description"
// end of the list of possible fields
}
]
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel. The maximum string length in characters is 50. |
|
title |
string Required field. Style preset title. The maximum string length in characters is 50. |
|
background_color |
string Required field. Background color. The maximum string length in characters is 50. Value must match the regular expression |
|
widget_text_color_primary |
string Required field. Widget primary text color. The maximum string length in characters is 50. Value must match the regular expression |
|
widget_text_color_secondary |
string Required field. Widget secondary text color. The maximum string length in characters is 50. Value must match the regular expression |
|
widget_accent_color |
string Required field. Widget accent color. The maximum string length in characters is 50. Value must match the regular expression |
|
widget_block_gap |
int64 Gap between widget blocks. Acceptable values are 0 to 50, inclusive. |
|
widget_block_separator_color |
string Required field. Line color between widget blocks. The maximum string length in characters is 50. Value must match the regular expression |
|
player_border_radius |
int64 Player border radius. The minimum value is 0. |
|
player_color |
string Required field. Player color. The maximum string length in characters is 50. Value must match the regular expression |
|
playlist_selected_item_background_color |
string Required field. Background color of selected video in playlist. The maximum string length in characters is 50. Value must match the regular expression |
|
playlist_item_border_radius |
int64 Playlist item border radius. The minimum value is 0. |
|
playlist_item_gap |
int64 Gap between videos in playlist. Acceptable values are 0 to 50, inclusive. |
|
playlist_location |
enum WidgetLocation Required field. Playlist widget location.
|
|
right_widgets[] |
List of widgets to display to the right of the player. |
|
bottom_widgets[] |
List of widgets to display below the player. |
Widget
Represents a UI component that displays additional content or functionality.
Widgets can be positioned in different locations around the player.
|
Field |
Description |
|
summarization |
Widget that displays video content summarization. Includes only one of the fields Specifies the type of widget to display. |
|
description |
Widget that displays detailed video description. Includes only one of the fields Specifies the type of widget to display. |
Summarization
Widget that presents an automatically generated summary of the video content.
This helps viewers quickly understand the main points without watching the entire video.
|
Field |
Description |
|
Empty |
|
Description
Widget that displays the full description text for the video.
This can include details about the content, creators, and other relevant information.
|
Field |
Description |
|
Empty |
|
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |