Общие данные медиаклиента (CMCD)

Клиентские приложения медиаплееров могут передавать ценную информацию в сети доставки контента (CDN) с каждым запросом объекта. Передача этих данных может улучшить мониторинг качества обслуживания (QoS), адаптивную оптимизацию трафика и производительность доставки, что в конечном итоге улучшит пользовательский опыт.

Реализация в ExoPlayer основана на спецификации, определенной в CTA-5004 .

Поддержка CMCD в Exoplayer

Поддержка CMCD в ExoPlayer может быть включена только для адаптивных форматов потоковой передачи, таких как DASH , HLS и SmoothStreaming .

Ключи данных CMCD

Ключи данных CMCD подразделяются на четыре различных типа:

  • CMCD-Request : ключи, значения которых меняются при каждом запросе.
  • CMCD-объект : ключи, значения которых зависят от запрашиваемого объекта.
  • CMCD-Status : ключи, значения которых не меняются при каждом запросе или объекте.
  • CMCD-Session : ключи, значения которых, как ожидается, останутся неизменными на протяжении всего времени действия сессии.

Способы передачи данных

Данные CMCD могут передаваться одним из двух способов:

  • В качестве пользовательского заголовка HTTP-запроса, что является поведением по умолчанию .
  • В качестве аргумента HTTP-запроса.

Включить CMCD

Для включения CMCD необходимо создать экземпляр CmcdConfiguration.Factory и передать его в MediaSource.Factory , используемый при создании проигрывателя . Вы можете использовать либо CmcdConfiguration.Factory по умолчанию, либо предоставить собственную пользовательскую фабрику, которая вызывается каждый раз при создании адаптивного источника мультимедиа для данного медиаэлемента.

Включить CMCD с использованием фабрики конфигураций по умолчанию.

Котлин

// Create media source factory and set default cmcdConfigurationFactory.
val mediaSourceFactory =
  DefaultMediaSourceFactory(context)
    .setCmcdConfigurationFactory(CmcdConfiguration.Factory.DEFAULT)

Java

// Create media source factory and set default cmcdConfigurationFactory.
MediaSource.Factory mediaSourceFactory =
    new DefaultMediaSourceFactory(context)
        .setCmcdConfigurationFactory(CmcdConfiguration.Factory.DEFAULT);

Включите CMCD с помощью пользовательской фабрики конфигураций.

Котлин

val cmcdConfigurationFactory =
  object : CmcdConfiguration.Factory {
    override fun createCmcdConfiguration(mediaItem: MediaItem): CmcdConfiguration {
      val cmcdRequestConfig =
        object : CmcdConfiguration.RequestConfig {
          override fun isKeyAllowed(key: String): Boolean {
            return key == "br" || key == "bl"
          }

          override fun getCustomData():
            ImmutableListMultimap<@CmcdConfiguration.HeaderKey String, String> {
            return ImmutableListMultimap.of(
              CmcdConfiguration.KEY_CMCD_OBJECT,
              "key1=stringValue",
            )
          }

          override fun getRequestedMaximumThroughputKbps(throughputKbps: Int): Int {
            return 5 * throughputKbps
          }
        }

      val sessionId = UUID.randomUUID().toString()
      val contentId = UUID.randomUUID().toString()

      return CmcdConfiguration(sessionId, contentId, cmcdRequestConfig, MODE_QUERY_PARAMETER)
    }
  }

// Create media source factory and set your custom cmcdConfigurationFactory.
val mediaSourceFactory =
  DefaultMediaSourceFactory(context).setCmcdConfigurationFactory(cmcdConfigurationFactory)

Java

CmcdConfiguration.Factory cmcdConfigurationFactory =
    mediaItem -> {
      CmcdConfiguration.RequestConfig cmcdRequestConfig =
          new CmcdConfiguration.RequestConfig() {
            @Override
            public boolean isKeyAllowed(String key) {
              return key.equals("br") || key.equals("bl");
            }

            @Override
            public ImmutableListMultimap<@HeaderKey String, String> getCustomData() {
              return ImmutableListMultimap.of(
                  CmcdConfiguration.KEY_CMCD_OBJECT, "key1=stringValue");
            }

            @Override
            public int getRequestedMaximumThroughputKbps(int throughputKbps) {
              return 5 * throughputKbps;
            }
          };

      String sessionId = UUID.randomUUID().toString();
      String contentId = UUID.randomUUID().toString();

      return new CmcdConfiguration(
          sessionId, contentId, cmcdRequestConfig, MODE_QUERY_PARAMETER);
    };

// Create media source factory and set your custom cmcdConfigurationFactory.
MediaSource.Factory mediaSourceFactory =
    new DefaultMediaSourceFactory(context)
        .setCmcdConfigurationFactory(cmcdConfigurationFactory);

Примеры данных CMCD

Эти примеры иллюстрируют допустимые комбинации данных, отправляемых при получении фрагментов медиафайлов:

  • В качестве пользовательских заголовков HTTP-запроса

       CMCD-Session:sid="6e2fb550-c457-11e9-bb97-0800200c9a66"
    
       CMCD-Request:mtp=25400 CMCD-Object:br=3200,d=4004,ot=v,tb=6000
       CMCD-Status:bs,rtp=15000
       CMCD-Session:sid="6e2fb550-c457-11e9-bb97-0800200c9a66"
    
  • В качестве аргументов HTTP-запроса

       ?CMCD=sid%3D%226e2fb550-c457-11e9-bb97-0800200c9a66%22
    
       ?CMCD=br%3D3200%2Cbs%2Cd%3D4004%2Cmtp%3D25400%2Cot%3Dv%2Crtp
       %3D15000%2Csid%3D%226e2fb550-c457-11e9-bb97-
       0800200c9a66%22%2Ctb%3D6000