Groopview iOS SDK

Introduction

Groopview provides a unique way for consumers to watch video content. Groopview has developed a mobile based application that combines video streaming, video chat, texting, and response capture (emojis), of live (Linear) or On Demand (VoD) content over the internet, on a real time basis.

Groopview technology is a mobile application that provides a unique way to synchronize streaming video, video chat and voice, and texting on a plurality of devices that are in various geographically distributed locations, at the same time, in real time. Consumers can invite their friends and/or family members to watch video together on a mobile device, and simultaneously overlay group video chat over streaming video and text each other, all in real time. The consumer who invites other people to join is called the moderator/host. The invitees joining the Groopview session are called participants.

Groopview technology also allows consumers to schedule a time in the future for a Groopview session by sending invites/notifications or send notifications to participants to join right now. In either case, each participant can accept or decline the invite. At the appointed time, the moderator/host of the invite can start a Groopview session described above.

Purpose

The purpose of the “Android SDK” is to allow Groopview Client and their mobile application developers to easily integrate the Groopview functionality into their existing Android application.

The sequence diagram below illustrates the interactions, when the Groopview Video Plugin is integrated with Client’s Player.

image

Scope

Besides application integration the Android SDK covers two player integration options:

  • Integrate Groopview SDK which includes SDK Player with Client’s Android Mobile Application
  • Integrate Groopview Video Plugin with Client’s Player

SDK Integration

System Prerequisites

Groopview iOS SDK requires the following system prerequisites.

iOS 13+

iOS 13 is the thirteenth major release of the iOS mobile operating system developed by Apple Inc. for their iPhone. iOS 13 introduces a dramatic new look for iPhone with Dark Mode. iOS 13 is faster and more responsive with optimizations across the system that improves application launch and reduces download sizes.

Swift 5+

Swift is a programming language for iOS application development. It is a safe, fast, and interactive programming language that combines the best in modern language thinking with wisdom from the wider Apple engineering culture and the diverse contributions from its open-source community. The compiler is optimized for performance and the language is optimized for development, without compromising on either.

SDK Integration Flow Chart

image

Build Automation Options

CocoaPods and Carthage are the two main dependency managers for developing applications on iOS. You can use either CocoaPods or Carthage, build automation tool, to load the Groopview SDK.

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 79 thousand libraries and is used in over 3 million apps. CocoaPods can help you scale your projects elegantly. CocoaPods is built with Ruby and is installable with the default Ruby available on iOS.

Carthage is a dependency manager for Objective-C and Swift projects. Carthage works by delegating tasks to Xcode and Git, minimizing new concepts as much as possible, so you can continue to use the tools you are already familiar with.

CocoaPods:

image

Carthage:

img

Groopview Integration and Customization Steps

Step 1: Set-up an Authorization Header
Before any communication, set-up an authorization header. Our technical team will provide the ClientKey for proper integration. You also must provide a view controller where users will be able to choose a video to watch. image

Step 2: Pass Firebase Cloud Messaging (FCM) registration token to allow users to receive push notifications from Groopview SDK

image
Step 3: Add New User
image
Step 4: Establish User Session
image
Step 5: Start a Groopview
Starting a Groopview from videos list

In “Movie Details”, add a Groopview Start Button which will initiate the Groopview flow by displaying the “User Screen” which allows the consumer to either create a new Groop selection or display an existing one.

image

Step 6: Video Player Integration
You can use a “Built-In SDK Video Player”. If you choose this option - you do not have to do anything else. However, you can also choose to use a “Custom Player” instead. In this option pass a reference to your custom video activity so we can direct the user when Groopview is ready and add GVGroopviewController to it.

To synchronize video for all participants constantly observe the host's playback time and pause/resume actions.

image

You will be notified when the user will exit the session

image

To get notified about playback changes implement GVGroopviewControllerDelegate in your video controller

image image

Resources

ONLINE SUPPORT

Take advantage of the easy-to-use, 24-hour support resources that are available on the Groopview Support Center Web site at . Online services include product updates/ notifications, user’s guides, a knowledge base, online help files, printable documentation, and more.

CLIENT SUCCESS PORTAL
A centralized access point to all Support resources including but not limited to best practice guides, checklists, training videos and the ability to create and track both active and historical support cases. Learn more

CLIENT SUPPORT PORTAL
Submit your request via our online submission form available on the Groopview Support Web site at here and receive an answer via email. Our response will include a ticket number and the name of the assigned support professional.