From 91a7fb263e62380f9948e615286bb06c4c6bee68 Mon Sep 17 00:00:00 2001
From: toxic-johann <353904974@qq.com>
Date: Sun, 26 Aug 2018 13:05:36 +0800
Subject: [PATCH] docs: add document about picture-in-picture

---
 doc/zh-cn/api/chimee-api.md | 26 ++++++++++++++++++++++++++
 doc/zh-cn/api/plugin-api.md | 26 ++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)

diff --git a/doc/zh-cn/api/chimee-api.md b/doc/zh-cn/api/chimee-api.md
index cf4c392b..6bfcbcee 100644
--- a/doc/zh-cn/api/chimee-api.md
+++ b/doc/zh-cn/api/chimee-api.md
@@ -584,6 +584,26 @@ player.$silentLoad('http://cdn.toxicjohann.com/%E4%BA%8E%E6%98%AF.mp4', option);
 option.abort = true;
 ```
 
+### requestPictureInPicture（v0.11.0后支持）
+
+画中画指 [Picture-in-Picture Api](https://wicg.github.io/picture-in-picture/)。点击[此处](https://googlechrome.github.io/samples/picture-in-picture/)可观看 google chrome 最新的 demo。
+
+为此， chimee 也给用户提供了相关的 api。
+
+在不支持画中画功能的浏览器上，我们使用 canvas 模拟画中画图标。
+
+该函数为异步函数，无需传入参数。
+
+调用此方法会触发`enterpictureinpicture` 事件。
+
+### exitPictureInPicture（v0.11.0后支持）
+
+退出画中画模式。
+
+同步函数，无需传入参数。
+
+调用此方法会触发`leavepictureinpicture`事件。
+
 ## video元素相关属性
 
 > \* 前缀为 chimee 自定义属性
@@ -776,6 +796,12 @@ const player = new Chimee({
 * 类型：`boolean`
 * 默认：`false`
 
+### inPictureInPictureMode（v0.11.0后支持）
+
+* 类型：`boolean`
+* 含义：该对象是否在画中画模式中
+* 默认：`false`
+
 ## container元素相关属性
 
 在 v0.5.0 后，chimee 提供入口直接操作 container 的配置。
diff --git a/doc/zh-cn/api/plugin-api.md b/doc/zh-cn/api/plugin-api.md
index 558310f6..4c94488e 100644
--- a/doc/zh-cn/api/plugin-api.md
+++ b/doc/zh-cn/api/plugin-api.md
@@ -599,6 +599,26 @@ this.$silentLoad('http://cdn.toxicjohann.com/%E4%BA%8E%E6%98%AF.mp4', option);
 option.abort = true;
 ```
 
+### requestPictureInPicture（v0.11.0后支持）
+
+画中画指 [Picture-in-Picture Api](https://wicg.github.io/picture-in-picture/)。点击[此处](https://googlechrome.github.io/samples/picture-in-picture/)可观看 google chrome 最新的 demo。
+
+为此， chimee 也给用户提供了相关的 api。
+
+在不支持画中画功能的浏览器上，我们使用 canvas 模拟画中画图标。
+
+该函数为异步函数，无需传入参数。
+
+调用此方法会触发`enterpictureinpicture` 事件。
+
+### exitPictureInPicture（v0.11.0后支持）
+
+退出画中画模式。
+
+同步函数，无需传入参数。
+
+调用此方法会触发`leavepictureinpicture`事件。
+
 ## video元素相关属性
 
 > \* 前缀为 chimee 自定义属性
@@ -817,6 +837,12 @@ const player = new Chimee({
 - 类型：`boolean`
 - 默认：`false`
 
+### inPictureInPictureMode（v0.11.0后支持）
+
+* 类型：`boolean`
+* 含义：该对象是否在画中画模式中
+* 默认：`false`
+
 > 还有更多属性可以直接获取，如下
 >
 > buffered, currentSrc, duration, error, ended, networkState, paused, readyState, seekable, sinkId, controlsList, tabIndex, dataset, offsetHeight, offsetLeft, offsetParent, offsetTop, offsetWidth