iOS SDK (Legacy)

The Dailymotion Swift iOS SDK is a swift wrapper around the WKWebView Class that allows developers to easily embed the Dailymotion Player in their app and let them communicate with its API natively.

The Swift iOS SDK is open source and you can get all required information plus a sample app here on our GitHub. It requires Xcode 8 and later, Swift 4 and iOS 8+. If you require an Objective-C version please check out our git here.

The Dailymotion iOS SDK, starting from version 3.10.0 has integrated the latest changes on the IDFA collection as part of the App Tracking Transparency compliance. It is recommended to all partners to utilize the latest SDK version, IDFA will not be collected on versions prior to 3.10.0 on iOS 14.5.

How to use:

1. Add our SDK to your project, the easiest way to do so is with CocoaPods, a dependency manager solution. Add the below pod to your Podfile.use_frameworks! pod 'DailymotionPlayerSDK'
2. Import DailymotionPlayerSDK into each file where you need to create an instance of Dailymotion player.import DailymotionPlayerSDK
3. Inside a view controller where you want to display the player, create a fresh DMPlayerViewController instance and set your view controller as delegate. Please, ensure your view controller conforms to the DMPlayerViewControllerDelegate protocol.

import DailymotionPlayerSDK class VideoViewController: UIViewController { private lazy var playerViewController: DMPlayerViewController = { let controller = DMPlayerViewController(parameters: [:]) controller.delegate = self return controller }() } //MARK: - Conform to protocol extension VideoViewController: DMPlayerViewControllerDelegate { func player(_ player: DMPlayerViewController, didReceiveEvent event: PlayerEvent) { } func player(_ player: DMPlayerViewController, openUrl url: URL) { } func playerDidInitialize(_ player: DMPlayerViewController) { } func player(_ player: DMPlayerViewController, didFailToInitializeWithError error: Error) { } }

4. Add the playerViewController as a child view controller. Then pass a video id to the player load() method. Once the player is initialized, it will take care of loading the video and start the playback.playerViewController.load(videoId: "x84sh87")

Using player parameters

To customize the player, select the required parameters from the player parameters list below and pass them to the player init method. The params value should contain a String Array with the customization values. If you don’t need any customization, pass an empty array.let parameters: [String: Any] = [ "controls": "false", //to hide the Player control buttons "ui-highlight": "FF0000", //to color the player UI using HEX value ] let playerViewController = DMPlayerViewController(parameters: parameters)

Some parameters can be passed in on player creation but also used with the load method to update their runtime config. These parameters include video, playlist, ads_params & start. These params require some encoding on the partner’s side. Please see the example below of the steps required.func loadVideo(withId id: String) { let parameters = ["start": 30] guard let encoded = try? JSONEncoder().encode(parameters), let params = String(data: encoded, encoding: .utf8) else { return } playerViewController.load(videoId: id, params: params) }

Player Parameters for iOS

Use the below parameters to customize your player via the iframe or SDK embed.

Methods

Our iOS SDK is loaded with all the functionality you need to create a unique video-centric application. Once the player is loaded, you can use the Player API and our player methods.playerViewController.play()

Events

The Player sends events when a specific Player property changes or becomes available. It is possible to add listeners to specific events: the exhaustive list of events is available below.

See an example of how to set a listener for loadedmetadata & apiready event.extension ViewController: DMPlayerViewControllerDelegate { func player(_ player: DMPlayerViewController, didReceiveEvent event: PlayerEvent) { switch event { case .namedEvent(let name, _) where name == "loadedmetadata": print("Player Metadata loaded") case .namedEvent(let name, _) where name == "apiready": print("Player is ready") default: break } } }

Player events

Video events

Ad events

Player properties

It is possible to get access to information about the player’s current state or specific player properties. Add a listener to an event and retrieve the corresponding player property, depending on the event type, use the data or position value.func player(_ player: DMPlayerViewController, didReceiveEvent event: PlayerEvent) { switch event { case .namedEvent(let name, let data): print("\(name) - \(data)") case .timeEvent(let name, let position): print("\(name) - \(position)") } }

Best practices

Player Ready Event:
When the player is ready to receive API commands it will send the apiready event. Listen to this event to ensure the player is ready to receive any API commands.

Preload player:
In your application, you can preload the player before the user attempts to play a video. In order to load the player, you must use the DMPlayerViewController() method, followed by the load method when you want to load a video in the player.

Reuse player:
When using our player in an application, you can (and should) reuse the same player instance, therefore a single-player instance can load multiple videos.

Handle fullscreen orientation and state:
The toggleFullscreen() method toggles the fullscreen UI component and the player fullscreen state, it doesn’t have control of the fullscreen functionality of your application. This method should be used alongside the native functionality adjusting the player orientation. You can see an example of how it could be handled in our sample application.

Sample application:
You can access a sample application utilizing our SDK from our git here. Check out the SDK repo and the sample will be available.

TCF2

The iOS SDK complies with IAB TCF2 standards and will take care of everything by default starting from version 3.8.0+. It will automatically access the stored content string and pass it through to the player.

OM SDK

Open Measurement SDK from IAB is designed to facilitate third-party viewability and verification measurement for ads served to web video and mobile app environments. For more details see here.

We have integrated the SDK in our Dailymotion Player SDK and it does more or less everything out of the box:

• Ad session management
• Ad main signals (play, buffer_start, buffer_end, pause, resume, quartiles, click)
• Device and Player volume management
• Basic Player state handling. NORMAL or FULLSCREEN based on Player fullscreen state.

Please note: The SDK includes a solution to ensure the OM SDK can recognize device volume changes by default. The default solution can be overridden by changing the following parameter ‘allowAudioSessionActive’ to ‘false’ in the ‘DMPlayerViewController’ init method. Overriding this function will result in verification scripts underreporting videos as non-audible, which can negatively affect revenue.DMPlayerViewController(parameters: [:], allowAudioSessionActive: false)

It is recommended to update the Player state at all times if your app uses a variety of Player layout, such as mini-Player, picture-in-picture, etc. This can be achieved by updating the ‘playerState’ property in your ‘DMPlayerViewController’ instance.player.playerState = .fullscreen

Player state