From 5534f9a2486d7370dda42212815855600435f3bd Mon Sep 17 00:00:00 2001 From: Azure CI <> Date: Thu, 14 May 2020 20:15:44 +0000 Subject: [PATCH] docs(ci): Update protocol.md - eb20654 [skip ci] --- docs/generated/comments.json | 41 ++++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 21 ++++++++++++++++++ 2 files changed, 62 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 28f82e48..dc7f68c2 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -8678,6 +8678,47 @@ "lead": "", "type": "class", "examples": [] + }, + { + "subheads": [], + "description": "Get the position of the current transition.", + "return": "{double} `position` current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active.", + "api": "requests", + "name": "GetTransitionPosition", + "category": "transitions", + "since": "4.8.0", + "returns": [ + { + "type": "double", + "name": "position", + "description": "current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active." + } + ], + "names": [ + { + "name": "", + "description": "GetTransitionPosition" + } + ], + "categories": [ + { + "name": "", + "description": "transitions" + } + ], + "sinces": [ + { + "name": "", + "description": "4.8.0" + } + ], + "heading": { + "level": 2, + "text": "GetTransitionPosition" + }, + "lead": "", + "type": "class", + "examples": [] } ] } diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 92db4587..2f553495 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -215,6 +215,7 @@ auth_response = base64_encode(auth_response_hash) + [SetCurrentTransition](#setcurrenttransition) + [SetTransitionDuration](#settransitionduration) + [GetTransitionDuration](#gettransitionduration) + + [GetTransitionPosition](#gettransitionposition) @@ -3372,3 +3373,23 @@ _No specified parameters._ --- +### GetTransitionPosition + + +- Added in v4.8.0 + +Get the position of the current transition. + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `position` | _double_ | current transition position. This value will be between 0.0 and 1.0. Note: Transition returns 1.0 when not active. | + + +--- +