Application Configuration Documentation

The Ant Media Server configurations can be made directly from the files as well as through the management console. The documentation of all the application settings are provided below.

App Settings Documentation

Settings File Under Applications

These settings are set for each applications and stored in the file <AMS_DIR>/webapps/<AppName>/WEB-INF/red5-web.properties.

Management panel allows some changes however, the file is much more extensive, see the link above to reach all the settings.

Use case example:

• Open the link https://antmedia.io/javadoc/io/antmedia/AppSettings.html.
• Find the setting that you need on the Field Summary Section. Check the description if needed. Most of the settings are self explanatory.
• Click on the name of the field i.e. aacEncodingEnabled

@Value("${settings.aacEncodingEnabled:true}")

private boolean aacEncodingEnabled

If aacEncodingEnabled is true, aac encoding will be active even if mp4 or hls muxing is not enabled, If aacEncodingEnabled is false, aac encoding is only activated if mp4 or hls muxing is enabled in the settings, This value should be true if you're sending stream to RTMP endpoints or enable/disable mp4 recording on the fly

• It is a boolean type and its default value is true as shown in the @Value section

** To change it, you should change the following folder <AMS_DIR>/webapps/<AppName>/WEB-INF/red5-web.properties

• If the setting is not already in <AMS_DIR>/webapps/<AppName>/WEB-INF/red5-web.properties you can add a new line to change it settings.aacEncodingEnabled=false

Generating the javadoc

Go to directory Ant-Media-Server-Common/

$ mvn javadoc:javadoc -Dshow=private

Maven will create javadoc containing all the classes, we need only AppSettings

Required files

• Ant-Media-Server-Common/target/site/apidocs/io/antmedia/AppSettings.html

• Ant-Media-Server-Common/target/site/apidocs/io/antmedia/package-summary.html

• Ant-Media-Server-Common/target/site/apidocs/io/antmedia/package-tree.html

• Ant-Media-Server-Common/target/site/apidocs/resources (dir)

• Ant-Media-Server-Common/target/site/apidocs/*.css

• Ant-Media-Server-Common/target/site/apidocs/*.js

Files must be in this order on the document file lets say its (AppSettingsDoc) - ( directory structure io/antmedia should be conserved for proper operation, don't put AppSettings.html directly in the document folder, it should be in io/antmedia/ )

/io/antmedia/AppSettings.html

/io/antmedia/package-summary.html

/io/antmedia/package-tree.html

/resources

/*.css

/*.js

Send the new versions to antmedia.io/javadoc