Info
Stay organized with collections
Save and categorize content based on your preferences.
The /osc/info
API returns basic information about the camera and functionality
it supports.
- This command takes no input.
Output
endpoints
object
This JSON object provides information on the ports the camera uses for endpoints.
Note: HTTPS endpoints are optional.
Error
- This command returns no errors.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThe \u003ccode\u003e/osc/info\u003c/code\u003e API provides essential details about the camera, such as manufacturer, model, firmware, and supported features.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes information on available endpoints, including HTTP and HTTPS ports for communication.\u003c/p\u003e\n"],["\u003cp\u003eThe API also indicates the camera's API level, which determines the set of supported commands and features.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eendpoints\u003c/code\u003e object within the response provides details on the camera's communication ports, including HTTP and optional HTTPS ports.\u003c/p\u003e\n"]]],["The `/osc/info` API, using a GET request, retrieves camera details without requiring input. The output includes the camera's manufacturer, model, serial number, firmware version, support URL, GPS/gyro status, uptime, supported APIs, and API level. It also provides an `endpoints` object with HTTP/HTTPS port information, and optionally vendor-specific data. API level determines support, with `cameraId` introduced in API 2.1. It doesn't have error responses.\n"],null,["# Info\n\nThe `/osc/info` API returns basic information about the camera and functionality\nit supports.\n\nInput\n-----\n\n- This command takes no input.\n\nOutput\n------\n\n| Name | Type | Description |\n|-------------------|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `manufacturer` | String | The camera manufacturer. |\n| `model` | String | The camera model. |\n| `serialNumber` | String | Serial number. |\n| `firmwareVersion` | String | Current firmware version. |\n| `supportUrl` | String | URL for the camera's support webpage. |\n| `gps` | Boolean | True if the camera has GPS. |\n| `gyro` | Boolean | True if the camera has Gyroscope. |\n| `uptime` | Integer | Number of seconds since the camera boot. |\n| `api` | String Array | List of supported APIs. |\n| `endpoints` | Object | A JSON object containing information about the camera's endpoints. See the next table. |\n| `apiLevel` | Integer Array | It is \\[1\\] by default when this field is missing. \\[1, 2\\] represents both API 1 and 2 are supported while \\[2\\] represents only API 2 is supported. It is the developer's responsibility to retrieve this information and implement differently based on the value. **This field was added in API level 2. Please also use 2 if you support API 2.1.** |\n| `cameraId` | String | A unique id representing the camera. **This field was added in API level 2.1 and is relevant to [Direct Upload](/streetview/open-spherical-camera/guides/direct-upload).** |\n| `_vendorSpecific` | [type](/streetview/open-spherical-camera/guides/osc/optional) | Vendor specific additional info about the camera. Please prefix vendor-specific keys with an underscore ( _ ) to avoid namespace collisions. |\n\n### `endpoints` object\n\nThis JSON object provides information on the ports the camera uses for endpoints.\n\n***Note: HTTPS endpoints are optional.***\n\n| Name | Type | Description |\n|--------------------|---------|-------------------------------------------------|\n| `httpPort` | Integer | Port for HTTP server. (Default 80) |\n| `httpUpdatesPort` | Integer | Port to receive updates over HTTP |\n| `httpsPort` | Integer | (Optional) Port for HTTPs server. (Default 443) |\n| `httpsUpdatesPort` | Integer | (Optional) Port to receive updates over HTTPs. |\n\nError\n-----\n\n- This command returns no errors.\n\n| Example ------- ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Request** | ```http GET /osc/info HTTP/1.1 Host: [camera ip address]:[httpPort] Accept: application/json X-XSRF-Protected: 1 ``` |\n| **Response (API 2)** | ```http HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { \"manufacturer\": \"AAA\", \"model\": \"BBB\", \"serialNumber\": \"CCC\", \"firmwareVersion\": \"DDD\", \"supportUrl\": \"EEE\", \"endpoints\": { \"httpPort\": 80, \"httpUpdatesPort\": 10080, ... }, \"gps\": true, \"gyro\": false, \"uptime\": 600, \"api\": [ \"/osc/info\", \"/osc/state\", \"/osc/checkForUpdates\", \"/osc/commands/execute\", \"/osc/commands/status\" ], \"apiLevel\": [1, 2] } ``` |\n| **Response (API 1)** | ```http HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { \"manufacturer\": \"AAA\", \"model\": \"BBB\", \"serialNumber\": \"CCC\", \"firmwareVersion\": \"DDD\", \"supportUrl\": \"EEE\", \"endpoints\": { \"httpPort\": 80, \"httpUpdatesPort\": 10080, ... }, \"gps\": true, \"gyro\": false, \"uptime\": 600, \"api\": [ \"/osc/info\", \"/osc/state\", \"/osc/checkForUpdates\", \"/osc/commands/execute\", \"/osc/commands/status\" ] } ``` |"]]
