CameraCaptureTask Class

Article
11/23/2015

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Allows an application to launch the Camera application. Use this to allow users to take a photo from your application.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone.Tasks..::.ChooserBase<(Of <(PhotoResult>)>)
Microsoft.Phone.Tasks..::.CameraCaptureTask

Namespace: Microsoft.Phone.Tasks
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Public NotInheritable Class CameraCaptureTask _
    Inherits ChooserBase(Of PhotoResult)

public sealed class CameraCaptureTask : ChooserBase<PhotoResult>

<CameraCaptureTask .../>

The CameraCaptureTask type exposes the following members.

Constructors

	Name	Description
	CameraCaptureTask	Initializes a new instance of the CameraCaptureTask class.

Top

Properties

	Name	Description
	TaskEventArgs	The EventArgs for the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	FireCompleted	Raises the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Show	Shows the Camera application. (Overrides ChooserBase<(Of <(TTaskEventArgs>)>)..::.Show()()().)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Completed	Occurs when a Chooser task is completed. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Remarks

Important Note:
Photos captured with the CameraCaptureTask API are always copied to the phone’s camera roll. If the customer has set up his or her phone for automatic uploads, these pictures will be copied to OneDrive and potentially shared with a broader audience than intended by your app. For this reason, if your app captures pictures that you explicitly do not want to be shared or uploaded, such as temporary images or images that contain private information, do not use the CameraCaptureTask API. Instead, you should use the PhotoCamera API to implement your own camera UI. For more information on creating camera apps, see How to create a base camera app for Windows Phone 8.

Photos captured with the CameraCaptureTask API are always copied to the phone’s camera roll. If the customer has set up his or her phone for automatic uploads, these pictures will be copied to OneDrive and potentially shared with a broader audience than intended by your app. For this reason, if your app captures pictures that you explicitly do not want to be shared or uploaded, such as temporary images or images that contain private information, do not use the CameraCaptureTask API. Instead, you should use the PhotoCamera API to implement your own camera UI. For more information on creating camera apps, see How to create a base camera app for Windows Phone 8.

Launch the Camera application by calling the Show method of the CameraCaptureTask object. Obtain the result of the chooser operation by handling the Completed event.

Important Note:
On Windows Phone, your application may be deactivated while the Camera application is in the foreground. To ensure that your application receives the result of the CameraCaptureTask, the object must be declared with class scope within the PhoneApplicationPage class and you must call the chooser constructor and assign the Completed event delegate within the page’s constructor. For more information about how to handle the activation and deactivation of your application, seeApp activation and deactivation for Windows Phone 8.

On Windows Phone, your application may be deactivated while the Camera application is in the foreground. To ensure that your application receives the result of the CameraCaptureTask, the object must be declared with class scope within the PhoneApplicationPage class and you must call the chooser constructor and assign the Completed event delegate within the page’s constructor. For more information about how to handle the activation and deactivation of your application, seeApp activation and deactivation for Windows Phone 8.

Memory allocated for the Camera Capture Task does not count toward total application memory use. This helps minimize the amount of memory your application uses to capture photos, which is particularly important when your application runs on a lower-memory device. For more information, see Developing apps for lower-memory phones for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.