Migrating to AEPMedia reference

This document is a reference comparison of AEPMedia (3.x) APIs against their equivalent ACPMedia (2.x) APIs.

The AEPMedia extension is implemented purely in Swift and is compatible with the AEPCore Swift SDK. To ensure a smooth transition from the ACPMedia SDK, there are no major changes on the API names or definition. For more details, follow the migration guide below for your Swift or Objective-C mobile application. If explanation beyond showing API differences is necessary, it will be captured as an info hint within that API's section.

AEPMedia classes

Type	AEP 3.x (Swift)	AEP 3.x (Objective-C)	ACP 2.x (Objective-C)
Primary Class	Media	AEPMobileMedia	ACPMedia

AEPMedia APIs

extensionVersion

AEP 3.x (Swift)

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

AEP 3.x (Objective-C)

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

ACP 2.x (Objective-C)

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

static var extensionVersion: String
Copied to your clipboard
static var extensionVersion: String

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

+ (nonnull NSString*) extensionVersion;
Copied to your clipboard
+ (nonnull NSString*) extensionVersion;

createTracker

AEP 3.x (Swift)

static func createTracker()
Copied to your clipboard
static func createTracker()

AEP 3.x (Objective-C)

+ (id<AEPMediaTracker> _Nonnull) createTracker;
Copied to your clipboard
+ (id<AEPMediaTracker> _Nonnull) createTracker;

ACP 2.x (Objective-C)

+(ACPMediaTracker* _Nullable) createTracker;
Copied to your clipboard
+(ACPMediaTracker* _Nullable) createTracker;

static func createTracker()
Copied to your clipboard
static func createTracker()

+ (id<AEPMediaTracker> _Nonnull) createTracker;
Copied to your clipboard
+ (id<AEPMediaTracker> _Nonnull) createTracker;

+(ACPMediaTracker* _Nullable) createTracker;
Copied to your clipboard
+(ACPMediaTracker* _Nullable) createTracker;

createTrackerWithConfig

AEP 3.x (Swift)

static func createTrackerWith(config: [String: Any]?)
Copied to your clipboard
static func createTrackerWith(config: [String: Any]?)

AEP 3.x (Objective-C)

+ (id<AEPMobileMediaTracker> _Nonnull) createTrackerWithConfig:(NSDictionary<NSString *,id) * _Nullable) config;
Copied to your clipboard
+ (id<AEPMobileMediaTracker> _Nonnull) createTrackerWithConfig:(NSDictionary<NSString *,id) * _Nullable) config;

ACP 2.x (Objective-C)

+ (ACPMediaTracker* _Nullable) createTrackerWithConfig: (NSDictionary* _Nullable) config;
Copied to your clipboard
+ (ACPMediaTracker* _Nullable) createTrackerWithConfig: (NSDictionary* _Nullable) config;

static func createTrackerWith(config: [String: Any]?)
Copied to your clipboard
static func createTrackerWith(config: [String: Any]?)

+ (id<AEPMobileMediaTracker> _Nonnull) createTrackerWithConfig:(NSDictionary<NSString *,id) * _Nullable) config;
Copied to your clipboard
+ (id<AEPMobileMediaTracker> _Nonnull) createTrackerWithConfig:(NSDictionary<NSString *,id) * _Nullable) config;

+ (ACPMediaTracker* _Nullable) createTrackerWithConfig: (NSDictionary* _Nullable) config;
Copied to your clipboard
+ (ACPMediaTracker* _Nullable) createTrackerWithConfig: (NSDictionary* _Nullable) config;

createMediaObject

AEP 3.x (Swift)

static func createMediaObjectWith(name: String, id: String, length: Double, streamType: String, mediaType: MediaType) -> [String: Any]?
Copied to your clipboard
static func createMediaObjectWith(name: String, id: String, length: Double, streamType: String, mediaType: MediaType) -> [String: Any]?

AEP 3.x (Objective-C)

+ (NSDictionary*<NSString *,id> *_Nullable) createMediaObjectWith: (NSString *, _Nonnull) name 
                                                               id: (NSString * _Nonnull) id
                                                           length: (double) length
                                                       streamType: (NSString * _Nonnull) streamType
                                                        mediaType: (enum AEPMediaType) mediaType;
Copied to your clipboard
+ (NSDictionary*<NSString *,id> *_Nullable) createMediaObjectWith: (NSString *, _Nonnull) name 
                                                               id: (NSString * _Nonnull) id
                                                           length: (double) length
                                                       streamType: (NSString * _Nonnull) streamType
                                                        mediaType: (enum AEPMediaType) mediaType;

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createMediaObjectWithName: (NSString* _Nonnull) name
                                             mediaId: (NSString* _Nonnull) mediaId
                                              length: (double) length
                                          streamType: (NSString* _Nonnull) streamType
                                           mediaType: (ACPMediaType) mediaType;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createMediaObjectWithName: (NSString* _Nonnull) name
                                             mediaId: (NSString* _Nonnull) mediaId
                                              length: (double) length
                                          streamType: (NSString* _Nonnull) streamType
                                           mediaType: (ACPMediaType) mediaType;

static func createMediaObjectWith(name: String, id: String, length: Double, streamType: String, mediaType: MediaType) -> [String: Any]?
Copied to your clipboard
static func createMediaObjectWith(name: String, id: String, length: Double, streamType: String, mediaType: MediaType) -> [String: Any]?

+ (NSDictionary*<NSString *,id> *_Nullable) createMediaObjectWith: (NSString *, _Nonnull) name 
                                                               id: (NSString * _Nonnull) id
                                                           length: (double) length
                                                       streamType: (NSString * _Nonnull) streamType
                                                        mediaType: (enum AEPMediaType) mediaType;
Copied to your clipboard
+ (NSDictionary*<NSString *,id> *_Nullable) createMediaObjectWith: (NSString *, _Nonnull) name 
                                                               id: (NSString * _Nonnull) id
                                                           length: (double) length
                                                       streamType: (NSString * _Nonnull) streamType
                                                        mediaType: (enum AEPMediaType) mediaType;

+ (NSDictionary* _Nonnull) createMediaObjectWithName: (NSString* _Nonnull) name
                                             mediaId: (NSString* _Nonnull) mediaId
                                              length: (double) length
                                          streamType: (NSString* _Nonnull) streamType
                                           mediaType: (ACPMediaType) mediaType;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createMediaObjectWithName: (NSString* _Nonnull) name
                                             mediaId: (NSString* _Nonnull) mediaId
                                              length: (double) length
                                          streamType: (NSString* _Nonnull) streamType
                                           mediaType: (ACPMediaType) mediaType;

createAdBreakObject

AEP 3.x (Swift)

static func createAdBreakObjectWith(name: String, position: Int, startTime: Double) -> [String: Any]?
Copied to your clipboard
static func createAdBreakObjectWith(name: String, position: Int, startTime: Double) -> [String: Any]?

AEP 3.x (Objective-C)

+ (NSDictionary<NSString * ,id> * _Nullable) createAdBreakObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                            startTime: (double) startTime,
Copied to your clipboard
+ (NSDictionary<NSString * ,id> * _Nullable) createAdBreakObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                            startTime: (double) startTime,

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createAdBreakObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                             startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createAdBreakObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                             startTime: (double) startTime;

static func createAdBreakObjectWith(name: String, position: Int, startTime: Double) -> [String: Any]?
Copied to your clipboard
static func createAdBreakObjectWith(name: String, position: Int, startTime: Double) -> [String: Any]?

+ (NSDictionary<NSString * ,id> * _Nullable) createAdBreakObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                            startTime: (double) startTime,
Copied to your clipboard
+ (NSDictionary<NSString * ,id> * _Nullable) createAdBreakObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                            startTime: (double) startTime,

+ (NSDictionary* _Nonnull) createAdBreakObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                             startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createAdBreakObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                             startTime: (double) startTime;

createAdObject

AEP 3.x (Swift)

static func createAdObjectWith(name: String, id: String, position: Int, length: Double) -> [String: Any]?
Copied to your clipboard
static func createAdObjectWith(name: String, id: String, position: Int, length: Double) -> [String: Any]?

AEP 3.x (Objective-C)

+ (NSDictionary<NSString * ,id>) * _Nullable) createAdObjectWith: (NSString * _Nonnull) name
                                                              id: (NSString * _Nonnull) id
                                                        position: (NSInteger) position
                                                          length: (double) length;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createAdObjectWith: (NSString * _Nonnull) name
                                                              id: (NSString * _Nonnull) id
                                                        position: (NSInteger) position
                                                          length: (double) length;

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createAdObjectWithName: (NSString* _Nonnull) name
                                             adId: (NSString* _Nonnull) adId
                                         position: (double) position
                                           length: (double) length;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createAdObjectWithName: (NSString* _Nonnull) name
                                             adId: (NSString* _Nonnull) adId
                                         position: (double) position
                                           length: (double) length;

static func createAdObjectWith(name: String, id: String, position: Int, length: Double) -> [String: Any]?
Copied to your clipboard
static func createAdObjectWith(name: String, id: String, position: Int, length: Double) -> [String: Any]?

+ (NSDictionary<NSString * ,id>) * _Nullable) createAdObjectWith: (NSString * _Nonnull) name
                                                              id: (NSString * _Nonnull) id
                                                        position: (NSInteger) position
                                                          length: (double) length;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createAdObjectWith: (NSString * _Nonnull) name
                                                              id: (NSString * _Nonnull) id
                                                        position: (NSInteger) position
                                                          length: (double) length;

+ (NSDictionary* _Nonnull) createAdObjectWithName: (NSString* _Nonnull) name
                                             adId: (NSString* _Nonnull) adId
                                         position: (double) position
                                           length: (double) length;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createAdObjectWithName: (NSString* _Nonnull) name
                                             adId: (NSString* _Nonnull) adId
                                         position: (double) position
                                           length: (double) length;

createChapterObject

AEP 3.x (Swift)

static func createChapterObjectWith(name: String, position: Int, length: Double, startTime: Double) -> [String: Any]?
Copied to your clipboard
static func createChapterObjectWith(name: String, position: Int, length: Double, startTime: Double) -> [String: Any]?

AEP 3.x (Objective-C)

+ (NSDictionary<NSString * ,id>) * _Nullable) createChapterObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                               length: (double) length
                                                            startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createChapterObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                               length: (double) length
                                                            startTime: (double) startTime;

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createChapterObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                                length: (double) length
                                             startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createChapterObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                                length: (double) length
                                             startTime: (double) startTime;

static func createChapterObjectWith(name: String, position: Int, length: Double, startTime: Double) -> [String: Any]?
Copied to your clipboard
static func createChapterObjectWith(name: String, position: Int, length: Double, startTime: Double) -> [String: Any]?

+ (NSDictionary<NSString * ,id>) * _Nullable) createChapterObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                               length: (double) length
                                                            startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createChapterObjectWith: (NSString * _Nonnull) name
                                                             position: (NSInteger) position
                                                               length: (double) length
                                                            startTime: (double) startTime;

+ (NSDictionary* _Nonnull) createChapterObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                                length: (double) length
                                             startTime: (double) startTime;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createChapterObjectWithName: (NSString* _Nonnull) name
                                              position: (double) position
                                                length: (double) length
                                             startTime: (double) startTime;

createQoEObject

AEP 3.x (Swift)

static func createQoEObjectWith(bitrate: Double, startupTime: Double, fps: Double, droppedFrames: Double) -> [String: Any]?
Copied to your clipboard
static func createQoEObjectWith(bitrate: Double, startupTime: Double, fps: Double, droppedFrames: Double) -> [String: Any]?

AEP 3.x (Objective-C)

+ (NSDictionary<NSString * ,id>) * _Nullable) createQoEObjectWith: (double) bitrate
                                                        startTime: (double) startTime
                                                              fps: (double) fps 
                                                    droppedFrames: (double) droppedFrames;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createQoEObjectWith: (double) bitrate
                                                        startTime: (double) startTime
                                                              fps: (double) fps 
                                                    droppedFrames: (double) droppedFrames;

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createQoEObjectWithBitrate: (double) bitrate
                                          startupTime: (double) startupTime
                                                  fps: (double) fps
                                        droppedFrames: (double) droppedFrames;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createQoEObjectWithBitrate: (double) bitrate
                                          startupTime: (double) startupTime
                                                  fps: (double) fps
                                        droppedFrames: (double) droppedFrames;

static func createQoEObjectWith(bitrate: Double, startupTime: Double, fps: Double, droppedFrames: Double) -> [String: Any]?
Copied to your clipboard
static func createQoEObjectWith(bitrate: Double, startupTime: Double, fps: Double, droppedFrames: Double) -> [String: Any]?

+ (NSDictionary<NSString * ,id>) * _Nullable) createQoEObjectWith: (double) bitrate
                                                        startTime: (double) startTime
                                                              fps: (double) fps 
                                                    droppedFrames: (double) droppedFrames;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createQoEObjectWith: (double) bitrate
                                                        startTime: (double) startTime
                                                              fps: (double) fps 
                                                    droppedFrames: (double) droppedFrames;

+ (NSDictionary* _Nonnull) createQoEObjectWithBitrate: (double) bitrate
                                          startupTime: (double) startupTime
                                                  fps: (double) fps
                                        droppedFrames: (double) droppedFrames;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createQoEObjectWithBitrate: (double) bitrate
                                          startupTime: (double) startupTime
                                                  fps: (double) fps
                                        droppedFrames: (double) droppedFrames;

createStateObject

AEP 3.x (Swift)

static func createStateObjectWith(stateName: String) -> [String: Any]
Copied to your clipboard
static func createStateObjectWith(stateName: String) -> [String: Any]

AEP 3.x (Objective-C)

+ (NSDictionary<NSString * ,id>) * _Nullable) createStateObjectWith: (NSString * _Nonnull) stateName;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createStateObjectWith: (NSString * _Nonnull) stateName;

ACP 2.x (Objective-C)

+ (NSDictionary* _Nonnull) createStateObjectWithName: (NSString* _Nonnull) stateName;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createStateObjectWithName: (NSString* _Nonnull) stateName;

static func createStateObjectWith(stateName: String) -> [String: Any]
Copied to your clipboard
static func createStateObjectWith(stateName: String) -> [String: Any]

+ (NSDictionary<NSString * ,id>) * _Nullable) createStateObjectWith: (NSString * _Nonnull) stateName;
Copied to your clipboard
+ (NSDictionary<NSString * ,id>) * _Nullable) createStateObjectWith: (NSString * _Nonnull) stateName;

+ (NSDictionary* _Nonnull) createStateObjectWithName: (NSString* _Nonnull) stateName;
Copied to your clipboard
+ (NSDictionary* _Nonnull) createStateObjectWithName: (NSString* _Nonnull) stateName;

Media tracker API reference

trackEvent

AEP 3.x (Swift)

func trackEvent(event: MediaEvent, info: [String: Any]?, metadata: [String: String]?)
Copied to your clipboard
func trackEvent(event: MediaEvent, info: [String: Any]?, metadata: [String: String]?)

AEP 3.x (Objective-C)

- (void) trackEvent: (enum AEPMediaEvent) event
               info: (NSDictionary* <NSString *,id> * _Nullable) info
               data: (NSDictionary* <NSString *,NSString> * _Nullable) data;
Copied to your clipboard
- (void) trackEvent: (enum AEPMediaEvent) event
               info: (NSDictionary* <NSString *,id> * _Nullable) info
               data: (NSDictionary* <NSString *,NSString> * _Nullable) data;

ACP 2.x (Objective-C)

  - (void) trackEvent: (ACPMediaEvent) event
                 info: (NSDictionary* _Nullable) info
                 data: (NSDictionary* _Nullable) data;
Copied to your clipboard
  - (void) trackEvent: (ACPMediaEvent) event
                 info: (NSDictionary* _Nullable) info
                 data: (NSDictionary* _Nullable) data;

func trackEvent(event: MediaEvent, info: [String: Any]?, metadata: [String: String]?)
Copied to your clipboard
func trackEvent(event: MediaEvent, info: [String: Any]?, metadata: [String: String]?)

- (void) trackEvent: (enum AEPMediaEvent) event
               info: (NSDictionary* <NSString *,id> * _Nullable) info
               data: (NSDictionary* <NSString *,NSString> * _Nullable) data;
Copied to your clipboard
- (void) trackEvent: (enum AEPMediaEvent) event
               info: (NSDictionary* <NSString *,id> * _Nullable) info
               data: (NSDictionary* <NSString *,NSString> * _Nullable) data;

  - (void) trackEvent: (ACPMediaEvent) event
                 info: (NSDictionary* _Nullable) info
                 data: (NSDictionary* _Nullable) data;
Copied to your clipboard
  - (void) trackEvent: (ACPMediaEvent) event
                 info: (NSDictionary* _Nullable) info
                 data: (NSDictionary* _Nullable) data;

trackSessionStart

AEP 3.x (Swift)

public func trackSessionStart(info: [String: Any], metadata: [String: String]? = nil)
Copied to your clipboard
public func trackSessionStart(info: [String: Any], metadata: [String: String]? = nil)

AEP 3.x (Objective-C)

- (void) trackSessionStart:(NSDictionary<NSString *,id> * _Nonnull) mediaInfo metadata:(NSDictionary<NSString *,NSString *> * _Nullable) data;
Copied to your clipboard
- (void) trackSessionStart:(NSDictionary<NSString *,id> * _Nonnull) mediaInfo metadata:(NSDictionary<NSString *,NSString *> * _Nullable) data;

ACP 2.x (Objective-C)

- (void) trackSessionStart: (NSDictionary* _Nonnull) mediaInfo data: (NSDictionary* _Nullable) contextData;
Copied to your clipboard
- (void) trackSessionStart: (NSDictionary* _Nonnull) mediaInfo data: (NSDictionary* _Nullable) contextData;

public func trackSessionStart(info: [String: Any], metadata: [String: String]? = nil)
Copied to your clipboard
public func trackSessionStart(info: [String: Any], metadata: [String: String]? = nil)

- (void) trackSessionStart:(NSDictionary<NSString *,id> * _Nonnull) mediaInfo metadata:(NSDictionary<NSString *,NSString *> * _Nullable) data;
Copied to your clipboard
- (void) trackSessionStart:(NSDictionary<NSString *,id> * _Nonnull) mediaInfo metadata:(NSDictionary<NSString *,NSString *> * _Nullable) data;

- (void) trackSessionStart: (NSDictionary* _Nonnull) mediaInfo data: (NSDictionary* _Nullable) contextData;
Copied to your clipboard
- (void) trackSessionStart: (NSDictionary* _Nonnull) mediaInfo data: (NSDictionary* _Nullable) contextData;

trackPlay

AEP 3.x (Swift)

func trackPlay()
Copied to your clipboard
func trackPlay()

AEP 3.x (Objective-C)

- (void) trackPlay;
Copied to your clipboard
- (void) trackPlay;

ACP 2.x (Objective-C)

- (void) trackPlay;
Copied to your clipboard
- (void) trackPlay;

func trackPlay()
Copied to your clipboard
func trackPlay()

- (void) trackPlay;
Copied to your clipboard
- (void) trackPlay;

- (void) trackPlay;
Copied to your clipboard
- (void) trackPlay;

trackPause

AEP 3.x (Swift)

func trackPause()
Copied to your clipboard
func trackPause()

AEP 3.x (Objective-C)

- (void) trackPause;
Copied to your clipboard
- (void) trackPause;

ACP 2.x (Objective-C)

- (void) trackPause;
Copied to your clipboard
- (void) trackPause;

func trackPause()
Copied to your clipboard
func trackPause()

- (void) trackPause;
Copied to your clipboard
- (void) trackPause;

- (void) trackPause;
Copied to your clipboard
- (void) trackPause;

trackComplete

AEP 3.x (Swift)

func trackComplete()
Copied to your clipboard
func trackComplete()

AEP 3.x (Objective-C)

- (void) trackComplete;
Copied to your clipboard
- (void) trackComplete;

ACP 2.x (Objective-C)

- (void) trackComplete;
Copied to your clipboard
- (void) trackComplete;

func trackComplete()
Copied to your clipboard
func trackComplete()

- (void) trackComplete;
Copied to your clipboard
- (void) trackComplete;

- (void) trackComplete;
Copied to your clipboard
- (void) trackComplete;

trackSessionEnd

AEP 3.x (Swift)

func trackSessionEnd()
Copied to your clipboard
func trackSessionEnd()

AEP 3.x (Objective-C)

- (void) trackSessionEnd;
Copied to your clipboard
- (void) trackSessionEnd;

ACP 2.x (Objective-C)

- (void) trackSessionEnd;
Copied to your clipboard
- (void) trackSessionEnd;

func trackSessionEnd()
Copied to your clipboard
func trackSessionEnd()

- (void) trackSessionEnd;
Copied to your clipboard
- (void) trackSessionEnd;

- (void) trackSessionEnd;
Copied to your clipboard
- (void) trackSessionEnd;

trackError

AEP 3.x (Swift)

func trackError(errorId: String)
Copied to your clipboard
func trackError(errorId: String)

AEP 3.x (Objective-C)

- (void) trackError: (NSString* _Nonnull) errorId;
Copied to your clipboard
- (void) trackError: (NSString* _Nonnull) errorId;

ACP 2.x (Objective-C)

- (void) trackError: (NSString* _Nonnull) errorId;
Copied to your clipboard
- (void) trackError: (NSString* _Nonnull) errorId;

func trackError(errorId: String)
Copied to your clipboard
func trackError(errorId: String)

- (void) trackError: (NSString* _Nonnull) errorId;
Copied to your clipboard
- (void) trackError: (NSString* _Nonnull) errorId;

- (void) trackError: (NSString* _Nonnull) errorId;
Copied to your clipboard
- (void) trackError: (NSString* _Nonnull) errorId;

updateCurrentPlayhead

AEP 3.x (Swift)

func updateCurrentPlayhead(time: Double)
Copied to your clipboard
func updateCurrentPlayhead(time: Double)

AEP 3.x (Objective-C)

- (void) updateCurrentPlayhead: (double) time;
Copied to your clipboard
- (void) updateCurrentPlayhead: (double) time;

ACP 2.x (Objective-C)

- (void) updateCurrentPlayhead: (double) time;
Copied to your clipboard
- (void) updateCurrentPlayhead: (double) time;

func updateCurrentPlayhead(time: Double)
Copied to your clipboard
func updateCurrentPlayhead(time: Double)

- (void) updateCurrentPlayhead: (double) time;
Copied to your clipboard
- (void) updateCurrentPlayhead: (double) time;

- (void) updateCurrentPlayhead: (double) time;
Copied to your clipboard
- (void) updateCurrentPlayhead: (double) time;

updateQoEObject

AEP 3.x (Swift)

func updateQoEObject(qoe: [String: Any])
Copied to your clipboard
func updateQoEObject(qoe: [String: Any])

AEP 3.x (Objective-C)

- (void) updateQoEObject: (NSDictionary*<NSString *,id> _Nonnull) qoeObject;
Copied to your clipboard
- (void) updateQoEObject: (NSDictionary*<NSString *,id> _Nonnull) qoeObject;

ACP 2.x (Objective-C)

- (void) updateQoEObject: (NSDictionary* _Nonnull) qoeObject;
Copied to your clipboard
- (void) updateQoEObject: (NSDictionary* _Nonnull) qoeObject;

func updateQoEObject(qoe: [String: Any])
Copied to your clipboard
func updateQoEObject(qoe: [String: Any])

- (void) updateQoEObject: (NSDictionary*<NSString *,id> _Nonnull) qoeObject;
Copied to your clipboard
- (void) updateQoEObject: (NSDictionary*<NSString *,id> _Nonnull) qoeObject;

- (void) updateQoEObject: (NSDictionary* _Nonnull) qoeObject;
Copied to your clipboard
- (void) updateQoEObject: (NSDictionary* _Nonnull) qoeObject;

Media constants

Media type

AEP 3.x (Swift)

public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}
Copied to your clipboard
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}

AEP 3.x (Objective-C)

@objc(AEPMediaType)
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}
Copied to your clipboard
@objc(AEPMediaType)
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}

ACP 2.x (Objective-C)

typedef NS_ENUM(NSInteger, ACPMediaType) {
    /**
    * Constant defining media type for Video streams
    */
    ACPMediaTypeVideo,

    /**
    * Constant defining media type for Audio streams
    */
    ACPMediaTypeAudio
};
Copied to your clipboard
typedef NS_ENUM(NSInteger, ACPMediaType) {
    /**
    * Constant defining media type for Video streams
    */
    ACPMediaTypeVideo,

    /**
    * Constant defining media type for Audio streams
    */
    ACPMediaTypeAudio
};

public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}
Copied to your clipboard
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}

@objc(AEPMediaType)
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}
Copied to your clipboard
@objc(AEPMediaType)
public enum MediaType: Int, RawRepresentable {
 //Constant defining media type for Video streams
 case Audio
 //Constant defining media type for Audio streams
 case Video
}

typedef NS_ENUM(NSInteger, ACPMediaType) {
    /**
    * Constant defining media type for Video streams
    */
    ACPMediaTypeVideo,

    /**
    * Constant defining media type for Audio streams
    */
    ACPMediaTypeAudio
};
Copied to your clipboard
typedef NS_ENUM(NSInteger, ACPMediaType) {
    /**
    * Constant defining media type for Video streams
    */
    ACPMediaTypeVideo,

    /**
    * Constant defining media type for Audio streams
    */
    ACPMediaTypeAudio
};

Stream type

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
}
Copied to your clipboard
public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
}

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
  @objc(AEPMediaStreamType)
  public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPMediaStreamType)
  public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
  }
}

ACP 2.x (Objective-C)

/**
 * Constant defining stream type for VOD streams
 */
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaStreamTypeVod;
Copied to your clipboard
/**
 * Constant defining stream type for VOD streams
 */
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaStreamTypeVod;

public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
}
Copied to your clipboard
public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
}

public class MediaConstants: NSObject {
  @objc(AEPMediaStreamType)
  public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPMediaStreamType)
  public class StreamType: NSObject {
     // Constant defining stream type for VOD streams.
        public static let VOD = "vod"
  }
}

/**
 * Constant defining stream type for VOD streams
 */
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaStreamTypeVod;
Copied to your clipboard
/**
 * Constant defining stream type for VOD streams
 */
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaStreamTypeVod;

Standard video constants

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
}
Copied to your clipboard
public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
}

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
  @objc(AEPVideoMetadataKeys)
  public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPVideoMetadataKeys)
  public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
  }
}

ACP 2.x (Objective-C)

FOUNDATION_EXPORT NSString* _Nonnull const ACPVideoMetadataKeyShow;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPVideoMetadataKeyShow;

public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
}
Copied to your clipboard
public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
}

public class MediaConstants: NSObject {
  @objc(AEPVideoMetadataKeys)
  public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPVideoMetadataKeys)
  public class VideoMetadataKeys: NSObject {
        public static let SHOW = "a.media.show"
  }
}

FOUNDATION_EXPORT NSString* _Nonnull const ACPVideoMetadataKeyShow;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPVideoMetadataKeyShow;

Standard audio constants

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
}
Copied to your clipboard
public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
}

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
  @objc(AEPAudioMetadataKeys)
  public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPAudioMetadataKeys)
  public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
  }
}

ACP 2.x (Objective-C)

FOUNDATION_EXPORT NSString* _Nonnull const ACPAudioMetadataKeyArtist;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPAudioMetadataKeyArtist;

public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
}
Copied to your clipboard
public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
}

public class MediaConstants: NSObject {
  @objc(AEPAudioMetadataKeys)
  public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPAudioMetadataKeys)
  public class AudioMetadataKeys: NSObject {
        public static let ARTIST = "a.media.artist"
  }
}

FOUNDATION_EXPORT NSString* _Nonnull const ACPAudioMetadataKeyArtist;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPAudioMetadataKeyArtist;

Standard ad constants

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

 public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
Copied to your clipboard
 public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
  @objc(AEPAdMetadataKeys)
  public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPAdMetadataKeys)
  public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
}

ACP 2.x (Objective-C)

FOUNDATION_EXPORT NSString* _Nonnull const ACPAdMetadataKeyAdvertiser;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPAdMetadataKeyAdvertiser;

 public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
Copied to your clipboard
 public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }

public class MediaConstants: NSObject {
  @objc(AEPAdMetadataKeys)
  public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPAdMetadataKeys)
  public class AdMetadataKeys: NSObject {
        public static let ADVERTISER = "a.media.ad.advertiser"
 }
}

FOUNDATION_EXPORT NSString* _Nonnull const ACPAdMetadataKeyAdvertiser;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPAdMetadataKeyAdvertiser;

Player state constants

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
}
Copied to your clipboard
public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
}

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
  @objc(AEPMediaPlayerState)
  public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPMediaPlayerState)
  public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
  }
}

ACP 2.x (Objective-C)

FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaPlayerStateFullScreen;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaPlayerStateFullScreen;

public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
}
Copied to your clipboard
public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
}

public class MediaConstants: NSObject {
  @objc(AEPMediaPlayerState)
  public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
  }
}
Copied to your clipboard
public class MediaConstants: NSObject {
  @objc(AEPMediaPlayerState)
  public class PlayerState: NSObject {
        public static let FULLSCREEN = "fullscreen"
  }
}

FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaPlayerStateFullScreen;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaPlayerStateFullScreen;

Media events

For the full list of constant type, please refer to the Media API reference.

AEP 3.x (Swift)

public enum MediaEvent: Int, RawRepresentable {
 // event type for AdBreak start
    case AdBreakStart
}
Copied to your clipboard
public enum MediaEvent: Int, RawRepresentable {
 // event type for AdBreak start
    case AdBreakStart
}

AEP 3.x (Objective-C)

@objc(AEPMediaEvent)
public enum MediaEvent: Int, RawRepresentable {
// event type for AdBreak start
    case AdBreakStart
}
Copied to your clipboard
@objc(AEPMediaEvent)
public enum MediaEvent: Int, RawRepresentable {
// event type for AdBreak start
    case AdBreakStart
}

ACP 2.x (Objective-C)

typedef NS_ENUM(NSInteger, ACPMediaEvent) {
    /**
     * Constant defining event type for AdBreak start
     */
    ACPMediaEventAdBreakStart,
}
Copied to your clipboard
typedef NS_ENUM(NSInteger, ACPMediaEvent) {
    /**
     * Constant defining event type for AdBreak start
     */
    ACPMediaEventAdBreakStart,
}

public enum MediaEvent: Int, RawRepresentable {
 // event type for AdBreak start
    case AdBreakStart
}
Copied to your clipboard
public enum MediaEvent: Int, RawRepresentable {
 // event type for AdBreak start
    case AdBreakStart
}

@objc(AEPMediaEvent)
public enum MediaEvent: Int, RawRepresentable {
// event type for AdBreak start
    case AdBreakStart
}
Copied to your clipboard
@objc(AEPMediaEvent)
public enum MediaEvent: Int, RawRepresentable {
// event type for AdBreak start
    case AdBreakStart
}

typedef NS_ENUM(NSInteger, ACPMediaEvent) {
    /**
     * Constant defining event type for AdBreak start
     */
    ACPMediaEventAdBreakStart,
}
Copied to your clipboard
typedef NS_ENUM(NSInteger, ACPMediaEvent) {
    /**
     * Constant defining event type for AdBreak start
     */
    ACPMediaEventAdBreakStart,
}

Media resume

AEP 3.x (Swift)

 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}
Copied to your clipboard
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}

AEP 3.x (Objective-C)

public class MediaConstants: NSObject {
 @objc(AEPMediaObjectKey)
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}
Copied to your clipboard
public class MediaConstants: NSObject {
 @objc(AEPMediaObjectKey)
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}

ACP 2.x (Objective-C)

FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaKeyMediaResumed;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaKeyMediaResumed;

 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}
Copied to your clipboard
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}

public class MediaConstants: NSObject {
 @objc(AEPMediaObjectKey)
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}
Copied to your clipboard
public class MediaConstants: NSObject {
 @objc(AEPMediaObjectKey)
 public class MediaObjectKey: NSObject {
        public static let RESUMED = "media.resumed"
    }
}

FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaKeyMediaResumed;
Copied to your clipboard
FOUNDATION_EXPORT NSString* _Nonnull const ACPMediaKeyMediaResumed;

API reference

Release notes

Was this helpful?

Yes

Migrating to AEPMedia reference

AEPMedia classes.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

AEPMedia APIs

extensionVersion.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

createTracker

createTrackerWithConfig

createMediaObject

createAdBreakObject

createAdObject

createChapterObject

createQoEObject

createStateObject

Media tracker API reference

trackEvent

trackSessionStart

trackPlay

trackPause

trackComplete

trackSessionEnd

trackError

updateCurrentPlayhead

updateQoEObject

Media constants

Media type

Stream type

Standard video constants

Standard audio constants

Standard ad constants

Player state constants

Media events

Media resume

AEPMedia classes

extensionVersion