Playback Header

Setting the SPL options parameter to playback-on-header triggers in the presence of the P-Acme-Playback header. You can configure the option on either the side receiving the header message or the side from which the message will be sent. If both trigger, then the configuration closest to the playback direction takes precedence.

This header can be part of any request or response, but playback can only start once media has been established. Playback stops automatically with a final response (200-299 or 400-699), unless explicitly turned off or another playback header requesting it to stop is received.

The Oracle® Enterprise Session Border Controller deletes the P-Acme-Playback after processing if the SPL option is configured for the call (either incoming or outgoing).

The header looks like this:

P-Acme-Playback: start
    ;media=media1
    ;duration=continuous
    ;direction=both
    ;stop-on-final-resp=true
Header Element Description
<start|stop> Required

Defines starting and stopping playback.

  • start: starts playback
  • stop: stops playback
[;media=<media-name>] Optional

Defines the name of the playback configuration to play. If unspecified, the playback configuration that was triggered by the header will play.

[;duration=<ms-value|once|continuous>] Optional

Defines the duration of playback. If unspecified, the value will be taken from the playback-config that was triggered.

  • ms-value: time value in milliseconds
  • once: plays playback media one time
  • continuous: loops the playback media
[;direction=<originator|terminator|both>] Optional

Defines the direction from which to play media. If unspecified, playback will begin in the realm, session agent, or SIP interface from which the header was received.

  • originator: plays in the west flow (original caller)
  • terminator: plays in the east flow (original callee)
  • both: plays in both directions
[;stop-on-final-resp=<true|false>] Optional

Defines whether or not to stop playing media upon the final response. If unspecified, this parameter is true.

  • true: stops playback automatically on a final response
  • false: stop only after a stop header is received or media terminated