starboard/extension/player_configuration.h

// Copyright 2024 The Cobalt Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef STARBOARD_EXTENSION_PLAYER_CONFIGURATION_H_
#define STARBOARD_EXTENSION_PLAYER_CONFIGURATION_H_

#ifdef __cplusplus
extern "C" {
#endif

#define kStarboardExtensionPlayerConfigurationName \
  "dev.starboard.extension.PlayerConfiguration"

typedef struct StarboardExtensionPlayerConfigurationApi {
  // Name should be the string kStarboardExtensionPlayerConfigurationName.
  // This helps to validate that the extension API is correct.
  const char* name;

  // This specifies the version of the API that is implemented.
  uint32_t version;

  // The fields below this point were added in version 1 or later.

  // This is used to enforce the underlying starboard player using decode
  // to texture mode to render video frames when it's available, no matter
  // what output mode is passed in SbPlayerCreate(). This function can be
  // null.
  void (*SetEnforceDecodeToTextureMode)(bool enforced);

  // This is used to enforce the underlying starboard player using tunnel mode
  // when it's available. This function can be null.
  void (*SetEnforceTunnelMode)(bool enforced);

} StarboardExtensionPlayerConfigurationApi;

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // STARBOARD_EXTENSION_PLAYER_CONFIGURATION_H_