Environment

public struct Environment

Окружение SDK — точка входа для создания плееров и управления глобальной конфигурацией.

СодержаниеСодержание

На этой странице:

• Свойства
• Инициализаторы
• Методы

ОписаниеОписание

Создайте один экземпляр Environment при запуске приложения. Используйте его для получения экземпляров YaPlayer.

Обновление конфигурацииОбновление конфигурации

Конфигурацию можно обновить в любой момент без пересоздания окружения.

Сетевые заголовкиСетевые заголовки

Добавьте глобальные заголовки для всех сетевых запросов плеера.

СвойстваСвойства

ИнициализаторыИнициализаторы

@available(*, deprecated, renamed: "init(configuration:)", message: "Use API with Configuration instead")
public init(from: From)

Создает окружение SDK.

Параметры:

• from — идентификатор приложения.

public init(configuration: Configuration)

Создает окружение SDK с заданной конфигурацией.

Параметры:

• configuration — конфигурация SDK с идентификатором приложения и необязательным провайдером информации о пользователе.

МетодыМетоды

public mutating func update(configuration: Configuration)

Обновляет конфигурацию SDK без пересоздания окружения.

Параметры:

• configuration — новая конфигурация.

public func setGlobalNetworkHeaders(_ headers: [String: String])

Устанавливает HTTP-заголовки, добавляемые ко всем сетевым запросам плеера.

Параметры:

• headers — словарь заголовков в формате [имя: значение].

public func setNetworkHeaders(for endpoint: ContentIdEndpoint, headers: [String: String])

Устанавливает HTTP-заголовки для запросов конкретного контента.

public static func set(telemetryEndpoint: QuasiEndpoint?)

Переопределяет эндпоинт для отправки телеметрии.

Параметры:

• telemetryEndpoint — пользовательский эндпоинт или nil для восстановления значения по умолчанию.

public static func set(perfEndpoint: QuasiEndpoint?)

Переопределяет эндпоинт для отправки данных о производительности (perf-событий).

Параметры:

• perfEndpoint — пользовательский эндпоинт или nil для восстановления значения по умолчанию.

public func player() -> YaPlayer

Создает новый экземпляр плеера.

Возвращаемое значение: новый экземпляр YaPlayer.

ПримерыПримеры

let configuration = Configuration(from: From(raw: "my-ios-app"))
var environment = Environment(configuration: configuration)

// ViewController.swift
let player = environment.player()

let newConfig = Configuration(from: From(raw: "my-ios-app"), clientInfoProvider: provider)
environment.update(configuration: newConfig)

environment.setGlobalNetworkHeaders(["Authorization": "Bearer \(token)"])