Video player SDK for iOS

The SDK allows you to embed a player for Cloud Video content into your iOS app.

To use the SDK, you need the Xcode IDE version 16.4 or higher and Swift version 5.8 or higher.

Adding a video player SDK libraryAdding a video player SDK library

Importing the librariesImporting the libraries

To import the libraries, add the following lines to your code file:

import CloudVideoPlayer
import CloudVideoPlayerUI

Using the SDKUsing the SDK

Set up the start of playbackSet up the start of playback

1. Import a library in the file:

   import CloudVideoPlayer
   

2. Create the Configuration, Environment, and YaPlayer objects:

   let environment = Environment(configuration: Configuration(from: From(raw: "your-app-bundle")))
   
   class ViewController: UIViewController {
     let player = environment.player()
   }
   

3. Create the VideoSurface UIView component, add it to the hierarchy, and attach to the player instance:

   let surface = VideoSurface()
   
   override func loadView() {
     super.loadView()
     self.view.addSubview(surface)
     surface.frame = UIScreen.main.bounds
   }
   
   override func viewDidLoad() {
     super.viewDidLoad()
     surface.attach(player: player)
   }
   

4. Start playback:

   if let source = ContentIdEndpoint(url: URL(string: "https://runtime.video.cloud.yandex.net/player/...")!) {
     player.set(source: source)
     player.play()
   }
   

Where https://runtime.video.cloud.yandex.net/player/... is a link to a video, broadcast, or playlist.

import CloudVideoPlayer

let environment = Environment(configuration: Configuration(from: From(raw: "your-app-bundle")))

class ViewController: UIViewController {

  let player = environment.player()
  let surface = VideoSurface()

  override func loadView() {
    super.loadView()
    self.view.addSubview(surface)
    surface.frame = UIScreen.main.bounds
  }

  override func viewDidLoad() {
    super.viewDidLoad()
    surface.attach(player: player)

    if let source = ContentIdEndpoint(url: URL(string: "https://runtime.video.cloud.yandex.net/player/...")!) {
      player.set(source: source)
      player.play()
    }
  }
}

Connecting a video player skinConnecting a video player skin

1. Import a library in the file:

   import CloudVideoPlayerUI
   

2. Create the VideoView UIView component, add it to the hierarchy, and connect to the player instance:

   let videoView = VideoView()
   
   override func loadView() {
     super.loadView()
     self.view.addSubview(videoView)
     videoView.frame = UIScreen.main.bounds
   }
   
   override func viewDidLoad() {
     super.viewDidLoad()
     videoView.attach(player: player)
   }
   

import CloudVideoPlayerUI

let videoView = VideoView()

override func loadView() {
  super.loadView()
  self.view.addSubview(videoView)
  videoView.frame = UIScreen.main.bounds
}

override func viewDidLoad() {
  super.viewDidLoad()
  videoView.attach(player: player)
}

Playback in SwiftUIPlayback in SwiftUI

To embed your player in SwiftUI, wrap VideoView from CloudVideoPlayerUI into UIViewRepresentable, then bind it to the YaPlayer instance created via Environment.

1. Import these libraries in the file:

   import SwiftUI
   import CloudVideoPlayer
   import CloudVideoPlayerUI
   

2. Create the Environment and YaPlayer objects:

   let environment = Environment(configuration: Configuration(from: From(raw: "your-app-bundle")))
   
   final class PlayerViewModel: ObservableObject {
     let player: YaPlayer = environment.player()
   
     init() {
       guard
         let url = URL(string: "https://runtime.video.cloud.yandex.net/player/..."),
         let source = ContentIdEndpoint(url: url)
       else {
         return
       }
       player.set(source: source)
       player.play()
     }
   }
   

3. Create the UIViewRepresentable type that creates your VideoView and calls attach(player:):

   struct VideoViewRepresentable: UIViewRepresentable {
     let player: YaPlayer
   
     func makeUIView(context: Context) -> VideoView {
       let view = VideoView()
       view.attach(player: player)
       return view
     }
   
     func updateUIView(_ uiView: VideoView, context: Context) {
       uiView.attach(player: player)
     }
   }
   

4. Add the wrapper to the SwiftUI hierarchy:

   struct ContentView: View {
     @StateObject private var viewModel = PlayerViewModel()
   
     var body: some View {
       VideoViewRepresentable(player: viewModel.player)
         .aspectRatio(16 / 9, contentMode: .fit)
         .frame(maxHeight: .infinity, alignment: .top)
     }
   }
   

Where https://runtime.video.cloud.yandex.net/player/... is a link to a video, broadcast, or playlist.

import SwiftUI
import CloudVideoPlayer
import CloudVideoPlayerUI

let environment = Environment(configuration: Configuration(from: From(raw: "your-app-bundle")))

final class PlayerViewModel: ObservableObject {
  let player: YaPlayer = environment.player()

  init() {
    guard
      let url = URL(string: "https://runtime.video.cloud.yandex.net/player/..."),
      let source = ContentIdEndpoint(url: url)
    else {
      return
    }
    player.set(source: source)
    player.play()
  }
}

struct VideoViewRepresentable: UIViewRepresentable {
  let player: YaPlayer

  func makeUIView(context: Context) -> VideoView {
    let view = VideoView()
    view.attach(player: player)
    return view
  }

  func updateUIView(_ uiView: VideoView, context: Context) {
    uiView.attach(player: player)
  }
}

struct ContentView: View {
  @StateObject private var viewModel = PlayerViewModel()

  var body: some View {
    VideoViewRepresentable(player: viewModel.player)
      .aspectRatio(16 / 9, contentMode: .fit)
      .frame(maxHeight: .infinity, alignment: .top)
  }
}

See alsoSee also

SDK library references:

• CloudVideoPlayer: Main library with Environment, YaPlayer, and VideoSurface objects and playback settings.
• CloudVideoPlayerUI: Additional UI component library with a ready-made VideoView player shell.