Add documentation for getLiveview method

baku89 · Sep 9, 2024 · e0625b9 · e0625b9
1 parent 6d8fbcc
commit e0625b9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/core/src/Tethr.ts b/core/src/Tethr.ts
@@ -570,6 +570,10 @@ export abstract class Tethr
 	async setLiveview(value: MediaStream): Promise<OperationResult> {
 		return UnsupportedOperationResult
 	}
+
+	/**
+	 * Get the liveview stream when liveview is running. Use {@link getCanStartLiveview} to check if the camera supports this action, and {@link startLiveview} or {@link stopLiveview} to control liveview.
+	 */
 	async getLiveview() {
 		return (await this.getLiveviewDesc()).value
 	}