AirPlay POSIX Receiver Platform APIs

Introduction

Platform APIs related to AirPlay POSIX Receiver.

Functions

AirPlayReceiverPlatformGetSupportedMetadata

Platform function called by AirPlay to get the metadata features supported by the accessory.

AirPlayReceiverPlatformSetMetadata

Platform function called by AirPlay to convey info (like artist, album etc) of the current content being played.

AirPlayReceiverPlatformGetSupportedMetadata

Platform function called by AirPlay to get the metadata features supported by the accessory.

void AirPlayReceiverPlatformGetSupportedMetadata( 
    AirPlayFeatures *supportedMetadata );  

Parameters

Discussion

This function is called by AirPlay to get the metadata features supported by the accessory. Platform should return a OR-ed bitmask of the values listed below to specify the various metadata features platform requires. This value should be based on the accessorie's ability to use the various metadata types.

	

        kAirPlayFeature_AudioMetaDataArtwork        Artwork image
        kAirPlayFeature_AudioMetaDataText           Text metadata like Artist, Album etc.
        kAirPlayFeature_AudioMetaDataProgress       Duration and Elapsed time info

	
	

AirPlay will pass down only the specified metadata to the Plaform during AirPlay streaming.

AirPlayReceiverPlatformSetMetadata

Platform function called by AirPlay to convey info (like artist, album etc) of the current content being played.

void AirPlayReceiverPlatformSetMetadata( 
    AirPlayMetadataType inType, 
    void *inValue );  

Parameters

Discussion

This function is called by AirPlay to inform Platform of a change in the value of the info for the currently playing content. Input parameter inType specifies the info type. The value of the metadata info is specified by the input parameter inValue. The type of the inValue parameter is dependent on the inType parameter as listed below:

	

              inType                         inValue
              -------                        -------
        - eAirPlayMetadataTitle              char *
        - eAirPlayMetadataAlbum              char *
        - eAirPlayMetadataArtist             char *
        - eAirPlayMetadataComposer           char *
        - eAirPlayMetadataArtwork            AirPlayAlbumArt_t *
        - eAirPlayMetadataProgress           AirPlayProgressInfo_t *

	
	

AirPlay calls this function whenever it detects a change in the metadata info. Platform should display the info to the end user if the accesssory has display capabilities.