Aviso

AppboyKit (também conhecido como o SDK Objective-C) não é mais suportado e foi substituído pelo Swift SDK. Não receberá mais novos recursos, correções de bugs, atualizações de segurança ou suporte técnico—no entanto, o envio de mensagens e a análise de dados continuarão a funcionar normalmente. Para saber mais, veja Apresentando o Novo SDK Braze Swift.

Guia de implementação de mensagem no app do SharePlay

O SharePlay é um recurso recém-lançado que permite aos usuários do FaceTime no iOS 15 ter uma experiência de mídia compartilhada entre seus dispositivos, oferecendo sincronização de áudio e vídeo em tempo real. O SharePlay é uma ótima maneira para os usuários experimentarem conteúdo com amigos e familiares, oferecendo aos clientes da Braze uma via adicional para conteúdo de vídeo e oportunidades para apresentar novos usuários ao seu aplicativo.

Visão geral

O novo framework GroupActivities lançado pela Apple como parte da atualização do iOS 15 permite que você aproveite o FaceTime integrando o SharePlay aos seus aplicativos com a ajuda das In-App Messages da Braze.

Quando os usuários iniciam um vídeo do SharePlay em uma chamada do FaceTime, um botão “Abrir” aparece na parte superior da tela de todos. Quando aberto, o áudio e o vídeo são sincronizados em todos os dispositivos compatíveis, permitindo que os usuários assistam a vídeos juntos em tempo real. Aqueles que não têm o app instalado são redirecionados para a App Store.

Reprodução de mídia sincronizada
Com a reprodução de mídia sincronizada, se uma pessoa pausar o vídeo do SharePlay, ele será pausado em todos os dispositivos.

Integração

A mensagem no app usada nesta integração é um controlador de visualização de mensagem no app modal com subclasse. Um guia de configuração pode ser encontrado no guia de implementação de casos de uso avançados de mensagens no app do iOS. Antes de integrar, certifique-se de adicionar o entitlement GroupActivities ao seu projeto Xcode.

Importante

Recomendamos abrir a documentação do Apple SharePlay lado a lado com este guia para concluir a integração.

Etapa 1: Sobrescrever e carregar o XIB

• swift

1
2
3
4
5
6
7
8

override var nibName: String {
  return "ModalVideoViewController"
}

/// Overriding loadView() from ABKInAppMessageModalViewController to provide our own view for the in-app message
override func loadView() {
  Bundle.main.loadNibNamed(nibName, owner: self, options: nil)
}

Etapa 2: Configurar o AVPlayer para mensagens no app

As mensagens no app podem reproduzir vídeos nativamente com um trabalho leve de desenvolvimento. Ao fazer isso, você tem acesso a todos os recursos do AVPlayerVideoController, como o SharePlay. A mensagem no app usada neste exemplo é um ABKInAppMessageModalViewController com subclasse que possui uma visualização personalizada para incorporar um player de vídeo nativo.

• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

func configureVideoPlayer() {
  guard let urlString = inAppMessage.extras?["video_url"] as? String,
        let url = URL(string: urlString) else { return }

  let videoTitle = inAppMessage.extras?["video_title"] as? String
  mediaItem = MediaItem(title: videoTitle ?? "Video Content", url: url)

  let asset = AVAsset(url: url)
  let playerItem = AVPlayerItem(asset: asset)
  player.replaceCurrentItem(with: playerItem)
  playerViewController.player = player

  addChild(playerViewController)
  videoPlayerContainer.addSubview(playerViewController.view)
  playerViewController.didMove(toParent: self)
}

Configuração do dashboard

Pares chave-valor: O arquivo de vídeo deve ser definido nos pares chave-valor da mensagem no app e não pode ser anexado ao item de mídia em si. Você também pode adicionar verificação de validade de URL em beforeInAppMessageDisplayed como uma proteção antes de exibir o conteúdo.

Disparo: A mensagem no app deve ser elegível para todos os usuários com reelegibilidade ativada. Isso pode ser feito definindo dois disparadores: um disparador padrão para lançar a mensagem e outro para lançá-la quando iniciada pelo SharePlay. Usuários que não estiverem no iOS 15 só poderão visualizar as mensagens localmente.

Importante

Tenha cuidado com outras mensagens no app disparadas no início da sessão que possam entrar em conflito entre si.

Etapa 3: Criar atividade de visualização em grupo

Crie um objeto que esteja em conformidade com o protocolo GroupActivity. O objeto será os metadados da GroupSession compartilhados ao longo do ciclo de vida do SharePlay.

• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

struct MediaItem: Hashable, Codable {
  let title: String
  let url: URL
}

@available(iOS 15, *)
struct MediaItemActivity: GroupActivity {
  static let activityIdentifier = "com.book-demo.GroupWatching"

  let mediaItem: MediaItem

  var metadata: GroupActivityMetadata {
    var metadata = GroupActivityMetadata()
    metadata.type = .watchTogether
    metadata.title = mediaItem.title
    metadata.fallbackURL = mediaItem.url
    return metadata
  }
}

Preparar para reprodução

Quando você se prepara para reproduzir o item de mídia, cada atividade de grupo tem três estados de prepareForActivation():

• .activationDisabled - visualização individual
• .activationPreferred - visualização conjunta
• .cancelled - ignorar e tratar de forma adequada

Quando o estado retorna como activationPreferred, esse é o sinal para ativar o restante do ciclo de vida da atividade de grupo.

Etapa 4: Iniciar mensagem no app a partir da API do SharePlay

A API GroupActivities determina se há um vídeo presente. Se houver, você deve disparar o evento personalizado para lançar sua mensagem no app compatível com SharePlay. O CoordinationManager é responsável pelas mudanças de estado do SharePlay, como quando o(s) usuário(s) sai(em) ou entra(m) na chamada.

• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

private var subscriptions = Set<AnyCancellable>()
private var selectedMediaItem: MediaItem? {
  didSet {
    // Ensure the UI selection always represents the currently playing media.
    guard let _ = selectedMediaItem else { return }

    if !BrazeManager.shared.inAppMessageCurrentlyVisible {
      BrazeManager.shared.logCustomEvent("SharePlay Event")
    }
  }
}

private func launchVideoPlayerIfNecessary() {
  CoordinationManager.shared.$enqueuedMediaItem
      .receive(on: DispatchQueue.main)
      .compactMap { $0 }
      .assign(to: \.selectedMediaItem, on: self)
      .store(in: &subscriptions)
}

Etapa 5: Sair de uma sessão de grupo ao dispensar a mensagem no app

Quando a mensagem no app é dispensada, é o momento apropriado para sair da sessão do SharePlay e descartar o objeto de sessão.

• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

override func viewDidDisappear(_ animated: Bool) {
  super.viewDidDisappear(animated)
  groupSession?.leave()
  CoordinationManager.shared.leave()
}

class CoordinationManager() {
...
  // Published values that the player, and other UI items, observe.
  @Published var enqueuedMediaItem: MediaItem?
  @Published var groupSession: GroupSession<MediaItemActivity>?

  // Clear activity when the user leaves
  func leave() {
    groupSession = nil
    enqueuedMediaItem = nil
  }
...
}

Configurar visibilidade do botão SharePlay

A melhor prática é ocultar ou exibir dinamicamente qualquer indicador do SharePlay. Use a variável isEligibleForGroupSession para observar se o usuário está atualmente em uma chamada do FaceTime ou não. Se ele estiver em uma chamada do FaceTime, um botão deve ficar visível para compartilhar o vídeo entre os dispositivos compatíveis no chat. Na primeira vez que o usuário inicia o SharePlay, um prompt aparecerá no dispositivo original para selecionar as opções. Um prompt subsequente aparecerá nos dispositivos dos usuários compartilhados para interagir com o conteúdo.

• swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

private var isEligibleForSharePlay: Bool = false {
  didSet {
    sharePlayButton.isHidden = !isEligibleForSharePlay
  }
}

override func viewDidLoad() {
  super.viewDidLoad()

  // SharePlay button eligibility
  groupStateObserver.$isEligibleForGroupSession
    .receive(on: DispatchQueue.main)
    .assign(to: \.isEligibleForSharePlay, on: self)
    .store(in: &subscriptions)
}