• How to add poster frames to Apple HLS streams (ID3 metadata) for App Store audio renditions (ModuleCupertinoLiveAttachPicture)

    This module illustrates how to add poster images to an iOS audio-only live stream that's produced by using the audio-only rendition of the App Store compliance technique. This is accomplished by adding ID3 metadata to the stream that's interpreted by the iOS player. The module will search for an image file in the Wowza media server's [install-dir]/content folder that has the file name [stream-name].[extension], where [extension] can be jpg, jpeg, or png. For example, if you use the stream name myStream to stream and add the file myStream.jpg, which is the desired poster frame in JPG format, then the module will use this image as the poster frame.

    • For on-demand audio and live audio streams that don't use the App Store compliance technique, you must use the ModuleCupertinoLiveAttachPicture2/ModuleCupertinoVODAttachPicture module.

    • With the App Store compliance configuration in place, you can test by using the following playback URL. Note the required ?wowzaaudioonly querystring.
    • The poster frame is only displayed for audio-only streams. For video streams, the poster frames aren't displayed.

    • When streaming MP3 files (audio on demand), embedded poster frames are automatically propagated to iOS streams.

    • When you use the API, a much broader set of ID3 metadata is supported than what this example module uses. For more details, refer to the com.wowza.wms.media.mp3.model.idtags package in the Wowza Streaming Engine server-side API.

    • Support for poster frames was dropped by Apple in iOS 8.0 and as a result, adding poster frames will only work on iOS versions prior to iOS 8.0.
    A compiled version of this module is included in the Wowza Module Collection.


    To enable this module, add the following module definition to your application. See Configure modules for details.

    Fully Qualified Class Name
    ModuleCupertinoLiveAttachPicture Shows how to add images to an iOS stream. com.wowza.wms.plugin.collection.module.ModuleCupertinoLiveAttachPicture


    After enabling the module, you can adjust the default logging setting by adding the following property to your application. See Configure properties for details.

    Root/Application cupertinoAttachPictureDebugLog Boolean true Extra debug logging (default: false).

    Wowza media server software and all components, including modules, source code, and other related items offered on this page, are copyrighted (c) 2006-2016 by Wowza Media Systems, LLC, all rights reserved, and are licensed pursuant to the Wowza Media Software End User License Agreement.
    Originally Published: 11-22-2010.
    Updated: For Wowza Streaming Engine 4.0.6 on 08-11-2014.

    If you're having problems or want to discuss this article, post in our forum.