Configure an Event Handler

To configure an event handler, follow these steps.

To configure an event handler

  1. Stop Media Server.
  2. Open the Media Server configuration file in a text editor.
  3. Set the OnStart, OnFinish, OnError, or OnQueueEvent parameter to specify the name of a section in the configuration file that contains the event handler settings.

    • To run an event handler for all asynchronous actions, set these parameters in the [Actions] section. For example:

      [Actions]
      OnStart=NormalEvents
      OnFinish=NormalEvents
      OnError=ErrorEvents
    • To run an event handler for a specific action, set these parameters in the [ActionName] section, where ActionName is the name of the action. The following example calls an event handler when the Example action starts and finishes successfully, and uses a different event handler to monitor the queue size:

      [Example]
      OnStart=NormalEvents
      OnFinish=NormalEvents
      OnQueueEvent=QueueSizeEvents
  4. Create a new section in the configuration file to contain the settings for your event handler. You must name the section using the name you specified with the OnStart, OnFinish, OnError, or OnQueueEvent parameter.

  5. In the new section, set the LibraryName parameter.

    LibraryName

    The type of event handler to use to handle the event.

    • To write event data to a text file, set this parameter to TextFileHandler, and then set the FilePath parameter to specify the path of the file.
    • To send event data to a URL, set this parameter to HttpHandler, and then use the HTTP event handler parameters to specify the URL, proxy server settings, credentials, and so on.
    • To run a Lua script, set this parameter to LuaHandler, and then use the LuaScript parameter to specify the script to run. For information about writing the script, see Write a Lua Script to Handle Events.

    For example:

    [NormalEvents]
    LibraryName=TextFileHandler
    FilePath=./events.txt
    
    [ErrorEvents]
    LibraryName=HTTPHandler
    URL=http://handlers:8080/lo-proxy/callback.htm?
    
    [QueueSizeEvents]
    LibraryName=LuaHandler
    LuaScript=./handle_queue_events.lua
  6. Save and close the configuration file. You must restart Media Server for your changes to take effect.