react-native-google-cast/src/api/useCastSession.ts

React Native wrapper for the Google Cast SDK for iOS and Android

import { useEffect, useState } from 'react'
import CastSession from './CastSession'
import SessionManager from './SessionManager'

export interface UseCastSessionOptions {
  /**
   * Skip updating the session when the app is suspended to background or resumed back.
   *
   * This is primarily targeted at iOS which by default [suspends sessions when backgrounded](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_cast_options#a0edf44953049a7d888847745a387c9dc). Alternatively, you can set `options.suspendSessionsWhenBackgrounded = false` when initializing the CastContext in `AppDelegate`.
   */
  ignoreSessionUpdatesInBackground?: boolean
}

/**
 * Hook that provides the current {@link CastSession}.
 *
 * @returns current session, or `null` if there's no session connected
 * @example
 * ```js
 * import { useCastSession } from 'react-native-google-cast'
 *
 * function MyComponent() {
 *   const castSession = useCastSession()
 *
 *   if (castSession) {
 *     castSession.client.loadMedia(...)
 *   }
 * }
 * ```
 */

export default function useCastSession(
  options?: UseCastSessionOptions
): CastSession | null {
  const ignoreBackground = options?.ignoreSessionUpdatesInBackground

  const [castSession, setCastSession] = useState<CastSession | null>(null)

  useEffect(() => {
    manager.getCurrentCastSession().then(setCastSession)

    const started = manager.onSessionStarted(setCastSession)

    const suspended = ignoreBackground
      ? null
      : manager.onSessionSuspended(() => setCastSession(null))

    const resumed = manager.onSessionResumed((session) => {
      if (ignoreBackground) {
        // only update the session if it's different from previous one
        setCastSession((s) => (s?.id === session.id ? s : session))
      } else {
        setCastSession(session)
      }
    })

    const ended = manager.onSessionEnded(() => setCastSession(null))

    return () => {
      started.remove()
      suspended?.remove()
      resumed?.remove()
      ended.remove()
    }
  }, [ignoreBackground])

  return castSession
}

const manager = new SessionManager()