Welcome to Everyplay iOS SDK Documentation
Getting Started
Prerequisites
To integrate Everyplay iOS SDK into your project, you’ll need:
- A Mac running macOS 10.14 or higher
- Xcode 11 or later
- An active developer account with Everyplay
- Your app’s bundle identifier
Installation
- Download the Everyplay iOS SDK from the official Everyplay website.
- Unzip the downloaded file.
- Open your Xcode project.
- Drag and drop the Everyplay.framework folder into your Xcode project, ensuring “Copy items if needed” is selected, and click Finish.
Configuration
- In Xcode, open your app’s Info.plist file.
- Add a new row with the key “EveryplayClientId” and set its value to your Everyplay client ID.
- Scroll down and add one more row with the key “NSCameraUsageDescription” and provide a brief description of why your app requires access to the camera.
- Save and close the Info.plist file.
Integration
Importing the SDK
In the file where you want to use Everyplay functionality, import the Everyplay library using the following line:
import Everyplay
Initializing Everyplay
Initialize Everyplay by calling the following method early in your app’s lifecycle, e.g., in the AppDelegate’s didFinishLaunchingWithOptions method:
Everyplay.initialize()
This will set up the Everyplay session and authenticate the user if necessary.
Recording Gameplay
To start recording gameplay, call:
Everyplay.startRecording()
Everyplay will automatically handle capturing and saving the gameplay video.
Stopping Recording
To stop the recording, call:
Everyplay.stopRecording()
Uploading Videos
Everyplay automatically uploads recorded videos when the user is on Wi-Fi and charging. However, you can also manually upload a video by calling:
Everyplay.upload()
Additional Functionality
In addition to recording and uploading gameplay videos, Everyplay offers several other features:
- Sharing: Allow users to share their gameplay videos on social media platforms.
- Editing: Enable users to trim their captured videos before sharing.
- Watch Later: Provide a “Watch Later” feature for users to save videos for later viewing.
- Analytics: Access analytics data related to user engagement and video views.
API Reference
Overview
The Everyplay iOS SDK provides a comprehensive set of APIs for integrating Everyplay features into your app.
Class Reference
The Everyplay iOS SDK includes several important classes:
- Everyplay: The main class for interacting with Everyplay functionality.
- EveryplayUser: Provides access to information about the current user.
- EveryplayVideo: Represents a recorded gameplay video.
- EveryplayThumbnail: Represents a thumbnail image associated with a recorded video.
Methods
The Everyplay iOS SDK provides a wide range of methods to interact with Everyplay features, such as:
- startRecording: Starts recording gameplay.
- stopRecording: Stops the recording.
- upload: Manually uploads a recorded video.
- share: Allows users to share a video on social media.
- trim: Enables video trimming functionality.
- And many more…
Example Code
Here’s an example of how to use Everyplay’s functionality in your app:
// Import the Everyplay library
import Everyplay
// Initialize Everyplay
Everyplay.initialize()
// Start recording gameplay
Everyplay.startRecording()
// ...gameplay happens...
// Stop recording
Everyplay.stopRecording()
// Upload the recorded video
Everyplay.upload()
// Allow users to share the video
Everyplay.share()
// Trim the video
Everyplay.trim()
Support and Troubleshooting
If you encounter any issues or need assistance, please refer to the Everyplay documentation on the official Everyplay website or contact their support team directly.
Conclusion
Congratulations! You have successfully integrated Everyplay iOS SDK into your app. Enjoy the powerful features it provides to enhance user engagement and gameplay sharing.