Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PhotoCapture.StartPhotoModeAsync

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public method StartPhotoModeAsync(setupParams: XR.WSA.WebCam.CameraParameters, onPhotoModeStartedCallback: XR.WSA.WebCam.PhotoCapture.OnPhotoModeStartedCallback): void;
public void StartPhotoModeAsync(XR.WSA.WebCam.CameraParameters setupParams, XR.WSA.WebCam.PhotoCapture.OnPhotoModeStartedCallback onPhotoModeStartedCallback);

Parameters

setupParamsThe various settings that should be applied to the web camera.
onPhotoModeStartedCallbackThis callback will be invoked once photo mode has been activated.

Description

Asynchronously starts photo mode.

Activates the web camera with the various settings specified in CameraParameters. Only one PhotoCapture instance can start the photo mode at any given time. After starting the photo mode, you make take photos via PhotoCapture.TakePhotoAsync. While in photo mode, more power will be consumed so make sure that you call PhotoCapture.StopPhotoModeAsync when you are done taking photos.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information