Skip to Content
Referencia APIPresets del reproductorObjeto de preset del reproductor

El objeto de preset del reproductor

Un preset del reproductor es un diseño de reproductor reutilizable. Creas y editas presets en la interfaz de administración de Ignite. Con una clave API puedes leer presets, por ejemplo para renderizar tu propio reproductor con el mismo diseño. Las claves API no pueden crear, actualizar ni eliminar presets.

El objeto de preset del reproductor es un objeto JSON con las siguientes propiedades:

{ "id": string, "title": string, "isDefault": boolean, "controls": boolean, "autoplay": boolean, "loop": boolean, "muted": boolean, "primaryColor": string, // hex or rgba, e.g. "#FFFFFF" "secondaryColor": string, "backgroundColor": string, "aspectRatio": "original" | "16/9" | "9/16" | "responsive" | "4/3" | "1/1" | "3/4" | "4/5", "uiRadius": number, "uiPadding": number, "initCaptions": boolean, "captionsOnFullscreen": boolean, "showTranscription": boolean, "captionsColorFont": string, "captionsColorBackground": string, "captionsRadius": number, "fullscreen": boolean, "allowAirPlay": boolean, "allowGoogleCast": boolean, "pictureInPicture": boolean, "showAudioTracks": boolean, "showSeekButtons": boolean, "fit": "contain" | "cover", "uiLanguage": string | null, // e.g. "de-DE", empty or null uses the browser language "limitQuality": "2160p" | "1080p" | "720p" | "540p" | "360p" | "240p", "aiContentLabel": "auto" | "off" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight", "createdAt": Date, "updatedAt": Date }

isDefault

Marca el preset predeterminado del espacio de trabajo. Solo un preset puede ser el predeterminado. Si creas un video sin preset, Ignite asigna el preset predeterminado al video.

Propiedades de diseño del reproductor

Todas las propiedades excepto id, title, isDefault, createdAt y updatedAt son ajustes de diseño del reproductor. El player.playerDesign del video usa las mismas propiedades. La configuración del reproductor embed describe qué hace cada ajuste.

La mayoría de las propiedades de diseño tienen un parámetro de URL equivalente en el reproductor embed. Estas propiedades usan un nombre distinto:

PropiedadParámetro de URL
primaryColorcolorPrimary
secondaryColorcolorSecondary
backgroundColorcolorBackground
allowAirPlayairPlay
allowGoogleCastgoogleCast
pictureInPicturepip
uiLanguagelang

aspectRatio no es un parámetro de URL. Consulta aspectRatio.

fullscreenOnPlay es solo un parámetro de URL. No se guarda en un preset del reproductor ni en player.playerDesign.

Los colores incluyen el prefijo # (por ejemplo #FFFFFF). Quita el # cuando pases un color hex como parámetro de URL.

Usar un preset en el reproductor embed

Para aplicar un preset a una inserción, pasa su id como parámetro de URL preset.