antmedia-server.media

Ant Media server reference.

type	object
properties
applicationSettings	For every applications in Antmedia you can set a some settings for it. If none are set the default values are used. Ant Media Server REST API ↗️ Default value is [[]]
	type	array
	default
	items	StreamApplicationSettingsEntity
connectTimeout	Timeout until the connection is dropped. Default value is [{“unit”:”SECONDS”,”value”:2}]
	default	unit	SECONDS
		value	2
	DurationConfigurationEntity
email	This email of the Ant Media server user to access the management API (different from the stream API). If there is no account pre-configured (if the ant media server is brand new this account will be created). This will then use the endpoint, the port and the /rest path to make request and manage the server Ant Media based on the Ant Media Server REST API ↗️
	type	string
hostname	This hostname of the Ant Media server. This is the IP or the hostname of the antmedia server. The address has to be absolute. For example, by default by deploying it in the OnSphere stack : http://backend-antmedia. This will then use the endpoint, the port and the /rest path to make request and add streams based on the Ant Media Server REST API ↗️
	type	string
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 Media module module.media ↗️ that this server will use to communicate. For example module.media.media-1 is the default OnSphere path of the Media module.
	type	string
password	This password corresponding to the email of the user you want to login with. If there is no account pre-configured (if the ant media server is brand new this account will be created). This will then use the endpoint, the port and the /rest path to make request and manage the server Ant Media based on the Ant Media Server REST API ↗️
	oneOf	PLAINTEXT
		SECRET
		ENCRYPTED
port	This endpoint of the Ant Media server. This is the port that will be used to access AntMedia from Onsphere. For example : 5080 for http or 5443 for https. This will then use the endpoint, the port and the /rest path to make request and add streams based on the Ant Media Server REST API ↗️
	type	integer
readTimeout	Timeout until read request is dropped Default value is [{“unit”:”SECONDS”,”value”:2}]
	default	unit	SECONDS
		value	2
	DurationConfigurationEntity
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

StreamApplicationSettingsEntity

type	object
properties
ipFilterEnabled	This is disabled by default otherwise we can not configure the server properly. It can be changed via the front-end interface if you know what you are doing. Default value is [false]
	type	boolean
	default	False
rtspPullTransportType	This sets the application to fetch the video of its RTSP broadcasts via tcp / udp or automatically. Default value is [“AUTO”]
	type	string
	enum	TCP, UDP, AUTO
	default	AUTO
startStreamFetcherAutomatically	This tells to the application if the broadcasts it contains should be fetched automatically or not. Default value is [true]
	type	boolean
	default	True
streamApplicationName	One of the application present in the AntMedia server.
	type	string
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

PLAINTEXT

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	The password to use in plaintext. It can be for example thisIs@TestPassword123.
	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	The path of the secret containing the password. This is a path to the secret containing the password.
	type	string
additionalProperties	False

ENCRYPTED

type	object
properties
type	type	string
	enum	ENCRYPTED
	default	ENCRYPTED
encryptedPassword	The password encrypted Base64(IV+AES256(password, input)) the password must be a shared secret available for the osp-configuration-dispatcher see documentation ↗️ see toolbox ↗️
	type	string
secretPath	The full path to the secret exposed by the orchestrator; this password is used to encrypt the encryptedPassword. see documentation ↗️ see toolbox ↗️
	type	string
additionalProperties	False