refactor: rename option to property

TzuHuanTai · Feb 21, 2025 · 57aed14 · 57aed14
1 parent 8a61d42
commit 57aed14
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -74,9 +74,9 @@ npm install picamera.js
   conn.connect();
   ```
 
-- ### Set camera options while streaming.
+- ### Set camera properties while streaming.
 
-  This example only set auto-focus and auto white balance. Other options see `CameraOptionType`.
+  This example only set auto-focus and auto white balance. Other properties see `CameraPropertyType`.
 
   ```javascript
   let videoRef = document.getElementById('videoElement');
@@ -96,12 +96,12 @@ npm install picamera.js
 
   // click the button with onclick="setAwb()" when it's connected
   setAwb = () => {
-    conn.setCameraOption(CameraOptionType.AWB_MODE, AwbModeEnum.AwbCloudy);
+    conn.setCameraProperty(CameraPropertyType.AWB_MODE, AwbModeEnum.AwbCloudy);
   }
 
-  // click the button with onclick="setCameraOption()" when it's connected
+  // click the button with onclick="setAf()" when it's connected
   setAf = () => {
-    conn.setCameraOption(CameraOptionType.AF_MODE, AfModeEnum.AfModeContinuous);
+    conn.setCameraProperty(CameraPropertynType.AF_MODE, AfModeEnum.AfModeContinuous);
   }
   ```
 
@@ -303,11 +303,11 @@ Available flags for initialization.
 
   Retrieves the current connection status.
 
-- ### setCameraOption
+- ### setCameraProperty
 
-  `.setCameraOption(key: CameraOptionType, value: CameraOptionValue)` 
+  `.setCameraProperty(key: CameraPropertyType, value: CameraPropertyValue)` 
 
-  Sets the camera option, such as 3A or so.
+  Sets camera properties, such as 3A or so.
 
 - ### snapshot
 

diff --git a/src/rtc/camera-options.ts → src/rtc/camera-property.ts b/src/rtc/camera-options.ts → src/rtc/camera-property.ts
@@ -1,5 +1,5 @@
 
-export enum CameraOptionType {
+export enum CameraPropertyType {
 	AE_ENABLE = 1,
 	AE_LOCKED = 2,
 	AE_METERING_MODE = 3,
@@ -146,4 +146,4 @@ export enum HdrChannelEnum {
 	HdrChannelLong = 3,
 };
 
-export type CameraOptionValue = HdrChannelEnum | HdrModeEnum | AfPauseStateEnum | AfStateEnum | AfPauseEnum | AfTriggerEnum | AfMeteringEnum | AfSpeedEnum | AfRangeEnum | AfModeEnum | AwbModeEnum | AeFlickerModeEnum | AeExposureModeEnum | AeConstraintModeEnum | AeMeteringModeEnum;
+export type CameraPropertyValue = HdrChannelEnum | HdrModeEnum | AfPauseStateEnum | AfStateEnum | AfPauseEnum | AfTriggerEnum | AfMeteringEnum | AfSpeedEnum | AfRangeEnum | AfModeEnum | AwbModeEnum | AeFlickerModeEnum | AeExposureModeEnum | AeConstraintModeEnum | AeMeteringModeEnum;
diff --git a/src/rtc/message.ts b/src/rtc/message.ts
@@ -1,4 +1,4 @@
-import { CameraOptionType, CameraOptionValue } from "./camera-options";
+import { CameraPropertyType, CameraPropertyValue } from "./camera-property";
 import { CommandType, MetadataCommand } from "./command";
 
 export class RtcMessage {
@@ -35,11 +35,11 @@ export type VideoMetadata = {
   path: string;
 }
 
-export class CameraOptionMessage {
-  key: CameraOptionType;
-  value: CameraOptionValue;
+export class CameraCtlMessage {
+  key: CameraPropertyType;
+  value: CameraPropertyValue;
 
-  constructor(key: CameraOptionType, value: CameraOptionValue) {
+  constructor(key: CameraPropertyType, value: CameraPropertyValue) {
     this.key = key;
     this.value = value;
   }

diff --git a/src/rtc/pi-camera.interface.ts b/src/rtc/pi-camera.interface.ts
@@ -1,6 +1,6 @@
 
 import { CodecType } from '../utils/rtc-tools';
-import { CameraOptionType, CameraOptionValue } from './camera-options';
+import { CameraPropertyType, CameraPropertyValue } from './camera-property';
 import { IMqttConnectionOptions } from '../mqtt/mqtt-client.interface';
 import { VideoMetadata } from './message';
 
@@ -105,11 +105,11 @@ export interface IPiCamera {
   fetchRecordedVideo(path: string): void;
 
   /** 
-   * Sets the camera option, such as 3A or so.
-   * @param key Camera Option Type
-   * @param value Value of the Camera Option
+   * Sets the camera property, such as 3A or so.
+   * @param key Camera property type
+   * @param value Value of the camera property
    */
-  setCameraOption(key: CameraOptionType, value: CameraOptionValue): void;
+  setCameraProperty(key: CameraPropertyType, value: CameraPropertyValue): void;
 
   /**
    * Requests a snapshot image from the server.

diff --git a/src/rtc/pi-camera.ts b/src/rtc/pi-camera.ts
@@ -8,9 +8,9 @@ import {
 } from '../utils/rtc-tools';
 import { CommandType, MetadataCommand } from './command';
 import { DEFAULT_TIMEOUT, MQTT_ICE_TOPIC, MQTT_SDP_TOPIC } from '../constants';
-import { CameraOptionMessage, MetaCmdMessage, RtcMessage, VideoMetadata } from './message';
+import { CameraCtlMessage, MetaCmdMessage, RtcMessage, VideoMetadata } from './message';
 import { IPiCamera, IPiCameraOptions } from './pi-camera.interface';
-import { CameraOptionType, CameraOptionValue } from './camera-options';
+import { CameraPropertyType, CameraPropertyValue } from './camera-property';
 import { addWatermarkToImage, addWatermarkToStream } from '../utils/watermark';
 import { DataChannelReceiver } from './datachannel-receiver';
 
@@ -148,10 +148,10 @@ export class PiCamera implements IPiCamera {
     }
   }
 
-  setCameraOption = (key: CameraOptionType, value: CameraOptionValue) => {
+  setCameraProperty = (key: CameraPropertyType, value: CameraPropertyValue) => {
     if (this.dataChannel?.readyState === 'open') {
-      const option = new CameraOptionMessage(key, value);
-      const command = new RtcMessage(CommandType.CAMERA_CONTROL, JSON.stringify(option));
+      const ctl = new CameraCtlMessage(key, value);
+      const command = new RtcMessage(CommandType.CAMERA_CONTROL, JSON.stringify(ctl));
       this.dataChannel.send(command.ToString());
     }
   }