Cloud Phone:Android SDK

1.1 Get the SDK and demo

dependencies {
    implementation fileTree(include the following: ['*.jar', '*.aar'], dir: 'libs')
    // The INI configuration parsing library that the aspengine SDK depends on.
    implementation 'org.ini4j:ini4j:0.5.4'
    // The libraries that wytrace depends on.
    implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.8'
    implementation 'com.google.code.gson:gson:2.10.1'
    implementation 'io.github.aliyun-sls:aliyun-log-android-sdk:2.7.0@aar'
}

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.VIBRATE"/>

1.2 Integration process

1.3 Best practices

For more information, see Cloud Phone quick integration best practices. The following figure describes the cloud phone integration process.

Multiple logon methods are available to obtain the ticket required by the SDK to connect to a Cloud Phone. The following flowchart shows the process.

For specific integration code, see the sample code for the lifecycle APIs.

2.1 Initialize and create a StreamView

@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   requestWindowFeature(Window.FEATURE_NO_TITLE);
   getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN, WindowManager.LayoutParams.FLAG_FULLSCREEN);
   setContentView(R.layout.activity_stream_view_demo);
   mStreamView = findViewById(R.id.stream_view);
   mStreamView.enableDesktopMode(false);
   mStreamView.scaleStreamVideo(pref.getBoolean("fit_video_content", true) ?
   mStreamView.ScaleType.FIT_STREAM_CONTENT : StreamView.ScaleType.FILL_STREAM_VIEW);
   mStreamView.getASPEngineDelegate().setAlignStreamResolutionWithSurfaceSize(false);
}

<?xml version="1.0" encoding="utf-8"?>
<android.widget.RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".StreamViewDemoActivity">

    <com.aliyun.wuying.aspsdk.aspengine.ui.StreamView
        android:id="@+id/stream_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:focusableInTouchMode="true"
        android:focusable="true"
        android:focusedByDefault="true" />

</android.widget.RelativeLayout>

2.2 Establish a connection

For more information about the values of mConfigs, see 4.1 Config.

mStreamView.start(mConfigs);

2.3 Disconnect

mStreamView.stop();

2.4 Destroy the StreamView instance

mStreamView.dispose();
mStreamView = null;

2.5 Multi-StreamView mode

This mode allows a stream to be seamlessly switched between multiple views. Perform the following steps:

1. Define and initialize the StreamView. For more information, see section 2.1.

2. Use IAspEngine to establish a connection. The parameters are the same as those defined in 4.1 Config.

   IASPEngine engine = mBuilder.enableRTC(true).build(context);
   // Enable data statistics.
   engine.enableStatistics(true, true);
   ConnectionConfig cc = new ConnectionConfig();
   cc.id = CONFIG_DESKTOP_ID;
   cc.connectionTicket = CONFIG_CONNECTION_TICKET;
   cc.useVPC = CONFIG_USE_VPC;
   cc.type = OS_TYPE;
   cc.user = CONFIG_USER;
   cc.uuid = CONFIG_UUID;
   
   engine.start(cc);

3. Bind the StreamView to the IAspEngine. This API renders the stream in the current view.

   mStreamView.bindASPEngine(engine);

4. Resume the binding between the StreamView and the IAspEngine. This API allows the view to resume rendering the stream.

   mStreamView.resumeASPEngine();

For more details, see the implementation in the demo.

2.6 Callback description

Sample code for registering and unregistering callbacks:

// Listen for connection callbacks.
mStreamView.getASPEngineDelegate().registerASPEngineListener(IASPEngineListener var1);
mStreamView.getASPEngineDelegate().unregisterASPEngineListener(IASPEngineListener var1);
// Listen for performance data callbacks.
mStreamView.getASPEngineDelegate().registerStatisticsListener(IStatisticsListener var1);
mStreamView.getASPEngineDelegate().unregisterStatisticsListener(IStatisticsListener var1);
// Listen for system permission requests.
mStreamView.registerSystemPermissionListener(IRequestSystemPermissionListener listener);
mStreamView.unregisterSystemPermissionListener(IRequestSystemPermissionListener listener);

6.2.1 initialize

You can implement this method to perform global initialization actions for the custom media engine.

This method is executed once during each streaming process.

public ErrorCode initialize()

Return value:

6.2.2 release

You can implement this method to perform global release actions for the custom media engine.

This method is executed once during each streaming process.

public ErrorCode release()

Return value:

6.2.3 enableStatistics

You can implement this method to enable or disable performance statistics collection.

public void enableStatistics(boolean enabled)

Parameters:

6.2.4 onCreateVideoStreamHandler

You can implement this method to provide the SDK with the media engine implementation for processing video stream data.

This method is executed once during each streaming process.

public IVideoStreamHandler onCreateVideoStreamHandler()

Return value:

6.2.5 onCreateAdaptiveGraphicStreamHandler

You can implement this method to provide the SDK with the media engine implementation for processing adaptive image stream data.

This method is executed once during each streaming process.

public IAdaptiveGraphicStreamHandler onCreatAdaptiveGraphicStreamHandler()

Return value:

6.2.6 onCreateAudioPlaybackStreamHandler

You can implement this method to provide the SDK with the media engine implementation for processing downstream audio data.

This method is executed once per streaming process.

public IAudioPlaybackStreamHandler onCreatAudioPlaybackStreamHandler()

Return value:

6.2.7 onCreateCursorBitmapHandler

You can implement this method to provide the SDK with the media engine implementation for processing cursor data.

This method is executed once during each streaming process.

The interface implementation provided by this method is used only when virtual mouse mode is enabled.

public ICursorBitmapHandler onCreatCursorBitmapHandler()

Return value:

6.3.1 setEventHandler

You can implement this method. When the custom media engine is loaded by the WUYING SDK, the SDK provides an `EventHandler` to your application through this method. You can use this handler to send video stream processing events.

public void setEventHandler(EventHandler handler)

Parameters:

6.3.2 addVideoTrack

You can implement this method. When a video stream is created, your application is notified through this method.

Currently, only one video stream can exist in a single streaming process.

ErrorCode addVideoTrack(int trackId, VProfile profile);

Parameters:

Return value:

6.3.3 setVideoSurface

You can implement this method. When the status of the `Surface` used for video rendering changes, your application is notified through this method.

ErrorCode setVideoSurface(int trackId, Surface surface);

Parameters:

Return value:

6.3.4 playVideo

You can implement this method. When the video stream is ready, your application is notified through this method.

ErrorCode playVideo(int trackId);

Parameters:

Return value:

6.3.5 removeVideoTrack

You can implement this method. When the video stream is destroyed, your application is notified through this method.

ErrorCode removeVideoTrack(int trackId);

Parameters:

Return value:

6.3.6 pushVideoFrame

You can implement this method. When a new video frame is received, your application is notified through this method.

ErrorCode setVideoSurface(int trackId, Surface surface);

Parameters:

Return value:

6.3.7 getVideoTracks

You can implement this method. The SDK calls this method to retrieve information about all video streams that are currently being processed from your application.

HashMap<Integer, VProfile> getVideoTracks();

Return value:

6.3.8 release

You can implement this method. When all video streams are destroyed, your application is notified through this method to perform cleanup actions.

ErrorCode release();

Return value:

6.4.1 initAudio

You can implement this method. When an audio channel is created in the SDK, your application is notified through this method.

ErrorCode initAudio();

Return value:

6.4.2 deInitAudio

You can implement this method. When the audio channel in the SDK is destroyed, your application is notified through this method.

ErrorCode deInitAudio();

Return value:

6.4.3 startAudioPlayback

You can implement this method. When the cloud computer is about to send an audio stream, your application is notified through this method.

ErrorCode startAudioPlayback();

Return value:

6.4.4 stopAudioPlayback

You can implement this method. When the cloud computer stops sending the audio stream, your application is notified through this method.

ErrorCode stopAudioPlayback();

Return value:

6.4.5 pushAudioPlaybackFrame

You can implement this method. When a new downstream audio frame is received, your application is notified through this method.

ErrorCode pushAudioPlaybackFrame(AFrame pbData);

Parameters:

Return value:

6.4.6 updateAudioPlaybackVol

You can implement this method. When the system volume on the cloud computer changes, your application is notified through this method.

ErrorCode updateAudioPlaybackVol(int volume);

Parameters:

Return value:

6.4.7 updateAudioPlaybackMute

You can implement this method. When the cloud computer is muted or unmuted, your application is notified through this method.

ErrorCode updateAudioPlaybackMute(int mute);

Parameters:

Return value:

6.4.8 release

You can implement this method. When the audio channel is destroyed, your application is notified through this method to perform cleanup actions.

ErrorCode release();

Return value:

6.5.1 setAdaptiveGraphicSurface

You can implement this method. When the status of the `Surface` used for image rendering changes, your application is notified through this method.

ErrorCode setAdaptiveGraphicSurface(Surface surface);

Parameters:

Return value:

6.5.2 invalidateAdaptiveGraphicSurface

You can implement this method. When new image frame data is received, your application is notified through this method.

ErrorCode invalidateAdaptiveGraphicSurface(Region region, byte[] buffer, BitmapFormat format);

Parameters:

Return value:

6.5.3 release

You can implement this method. When the image stream is destroyed, your application is notified through this method to perform cleanup actions.

ErrorCode release();

Return value:

6.6.1 setCursorBitmap

You can implement this method. When the cursor shape on the cloud computer changes, your application is notified through this method.

ErrorCode setCursorBitmap(CursorBitmap bitmap);

Parameters:

Return value:

6.6.2 unsetCursorBitmap

You can implement this method. When the cursor on the cloud computer is hidden, your application is notified through this method.

ErrorCode unsetCursorBitmap();

Return value:

6.6.3 setCursorPosition

You can implement this method. When the cursor position on the cloud computer changes, your application is notified through this method.

ErrorCode setCursorPosition(float x, float y);

Parameters:

Return value:

6.6.4 release

You can implement this method. When the connection is disconnected and the cursor display is canceled, your application is notified through this method to perform cleanup actions.

ErrorCode release();

Return value: