output.media

Media Output File

oneOf

Media start action output file.

Media stop action output file.

Media add to selector output file.

Media remove from selector output file.

Media start action output file.

type

object

properties

  • type

type

string

enum

START_STREAM

default

START_STREAM

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The module responsible of this command being executed.

For example : “modules.media.media-1”

This module will use its configured servers to handle the stream / selector interaction request.

Learn more about the Media features ↗️.

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

Media stop action output file.

type

object

properties

  • type

type

string

enum

STOP_STREAM

default

STOP_STREAM

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The module responsible of this command being executed.

For example : “modules.media.media-1”

This module will use its configured servers to handle the stream / selector interaction request.

Learn more about the Media features ↗️.

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

Media add to selector output file.

type

object

properties

  • type

type

string

enum

ADD_TO_SELECTOR

default

ADD_TO_SELECTOR

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The module responsible of this command being executed.

For example : “modules.media.media-1”

This module will use its configured servers to handle the stream / selector interaction request.

Learn more about the Media features ↗️.

type

string

  • selectorId

The selector in which to add the stream to.

For example : root.selector1

By adding a stream to a selector it will enable this one to be accessible in the front-end widget.

Learn more about the Media module ↗️.

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

Media remove from selector output file.

type

object

properties

  • type

type

string

enum

REMOVE_FROM_SELECTOR

default

REMOVE_FROM_SELECTOR

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The module responsible of this command being executed.

For example : “modules.media.media-1”

This module will use its configured servers to handle the stream / selector interaction request.

Learn more about the Media features ↗️.

type

string

  • selectorId

The selector in which to add the stream to.

For example : root.selector1

By adding a stream to a selector it will enable this one to be accessible in the front-end widget.

Learn more about the Media features ↗️.

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False