Viam SDK
    Preparing search index...

    Class GetPropertiesResponse

    from message viam.component.camera.v1.GetPropertiesResponse

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    distortionParameters? extrinsicParameters? frameRate? intrinsicParameters? mimeTypes supportsPcd fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    distortionParameters?: DistortionParameters

    Parameters for modeling lens distortion in cameras If camera does not provide distortion parameters, leave the field empty Initializing the parameters with 0-values is considered an error

    from field: viam.component.camera.v1.DistortionParameters distortion_parameters = 3;

    extrinsicParameters?: ExtrinsicParameters

    Parameters for the camera's position relative to a reference frame If camera does not provide extrinsic parameters, leave the field empty

    from field: viam.component.camera.v1.ExtrinsicParameters extrinsic_parameters = 6;

    frameRate?: number

    Optional camera frame rate for image capture timing

    from field: optional float frame_rate = 5;

    intrinsicParameters?: IntrinsicParameters

    Parameters for doing a perspective of a 3D scene to a 2D plane If camera does not provide intrinsic parameters, leave the field empty Initializing the parameters with 0-values is considered an error

    from field: viam.component.camera.v1.IntrinsicParameters intrinsic_parameters = 2;

    mimeTypes: string[]

    Supported MIME types by the camera

    from field: repeated string mime_types = 4;

    supportsPcd: boolean

    A boolean property determining whether the camera supports the return of pointcloud data

    from field: bool supports_pcd = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.component.camera.v1.GetPropertiesResponse"

    Methods

    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods