Package org.linphone.core

Interface VideoSourceDescriptor

public interface VideoSourceDescriptor

Object that is used to describe a video source.

Method Summary

Modifier and Type	Method	Description
VideoSourceDescriptor	clone()	Instantiate a new video source descriptor with values from source.
Call	getCall()	Gets the call of a VideoSourceDescriptor.
java.lang.String	getCameraId()	Gets the camera id of a VideoSourceDescriptor.
java.lang.String	getImage()	Gets the image path of a VideoSourceDescriptor.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
VideoSourceType	getType()	Gets the type of a VideoSourceDescriptor.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
void	setCall(Call call)	Sets the source of a VideoSourceDescriptor with a call.
void	setCameraId(java.lang.String cameraId)	Sets the source of a VideoSourceDescriptor with a camera id.
void	setImage(java.lang.String imagePath)	Sets the source of a VideoSourceDescriptor with an image path.
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getCall

@Nullable
Call getCall()

Gets the call of a VideoSourceDescriptor.

Returns:

The Call of the video source descriptor if it's type is
LinphoneVideoSourceCall, null otherwise.

setCall

void setCall(@Nullable
             Call call)

Sets the source of a VideoSourceDescriptor with a call.

Setting a VideoSourceDescriptor with a call will require the lib to
have two calls running at the same time. To do so the media resource mode has
to be set to LinphoneSharedMediaResources with Core.setMediaResourceMode(org.linphone.core.MediaResourceMode)
.

Parameters:

call - The Call that will be used as a video source.

getCameraId

@Nullable
java.lang.String getCameraId()

Gets the camera id of a VideoSourceDescriptor.

Returns:

The camera id of the video source descriptor if it's type is
LinphoneVideoSourceCamera, null otherwise.

setCameraId

void setCameraId(@Nullable
                 java.lang.String cameraId)

Sets the source of a VideoSourceDescriptor with a camera id.

Parameters:

cameraId - The camera id that will be used as a video source.

getImage

@Nullable
java.lang.String getImage()

Gets the image path of a VideoSourceDescriptor.

Returns:

The image path of the video source descriptor if it's type is
LinphoneVideoSourceImage, null otherwise.

setImage

void setImage(@Nullable
              java.lang.String imagePath)

Sets the source of a VideoSourceDescriptor with an image path.

Parameters:

imagePath - The image path that will be used as a video source.

getType

VideoSourceType getType()

Gets the type of a VideoSourceDescriptor.

Returns:

The VideoSourceType corresponding to this video source
descriptor.

clone

@NonNull
VideoSourceDescriptor clone()

Instantiate a new video source descriptor with values from source.

Returns:

The newly created VideoSourceDescriptor object.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object