通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
Documentation
All
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Playback configurations for a video track. Set the playback configurations for a video track when calling ILocalVideoTrack.play.

Hierarchy

  • VideoPlayerConfig

Index

Properties

Properties

Optional fit

fit: "cover" | "contain" | "fill"

Sets video display mode:

  • "cover": The image files the height and width of the box, while maintaining its aspect ratio but often cropping the image in the process. For more information, see the cover option of object-fit in CSS.
  • "contain": The size of the image increases or decreases to fill the box while preserving its aspect-ratio. Areas that are not filled due to the disparity in the aspect ratio are filled with black. For more information, see the contain option of object-fit in CSS.
  • "fill": The image stretches to fit the box, regardless of its aspect-ratio. For more information, see the fill option of object-fit in CSS.

Notes:

  • When playing the local camera video track, the SDK uses cover mode by default; when playing the local video track of screen sharing, the SDK uses contain mode by default.
  • When playing the remote video track, the SDK uses cover mode by default.

Optional mirror

mirror: undefined | false | true

Sets whether to enable mirror mode:

  • true: Enable mirror mode.
  • false: Disable mirror mode.

Notes:

  • The SDK enables mirror mode for the local video track by default.
  • The SDK disables mirror mode for the remote video track by default.