TcrRenderView (TcrSdkFull 3.3.1 API)

java.lang.Object
- FrameLayout
- - com.tencent.tcr.sdk.api.view.TcrRenderView

```
public abstract class TcrRenderView
extends FrameLayout
```
This view is used to render and display the cloud streaming video.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TcrRenderView.InputDeviceType` An enumeration that defines the input device type.
`static interface`	`TcrRenderView.Observer` This interface represents the observer of TcrRenderView.
`static class`	`TcrRenderView.ScaleType` An enumeration that defines the video scaling type.
`static class`	`TcrRenderView.TcrRenderViewType` An enumeration that defines the types of the rendering view.
`static class`	`TcrRenderView.VideoRotation` An enumeration that defines the video rotation angle.

Field Summary

Fields
Modifier and Type Field and Description

protected TcrRenderView.Observer mObserver

protected View mRenderView

protected TcrRenderView.TcrRenderViewType mTcrRenderViewType

Fields
Modifier and Type	Field and Description
`protected TcrRenderView.Observer`	`mObserver`
`protected View`	`mRenderView`
`protected TcrRenderView.TcrRenderViewType`	`mTcrRenderViewType`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TcrRenderView(Context context, TcrRenderView.TcrRenderViewType type, TcrSession session)` The constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract View`	`createRenderView(TcrRenderView.TcrRenderViewType type)` 创建渲染视图
`boolean`	`dispatchGenericMotionEvent(MotionEvent event)`
`boolean`	`dispatchKeyEvent(KeyEvent event)`
`java.util.Map`	`getKeyCodeMapping(TcrRenderView.InputDeviceType inputDeviceType)` Returns a mapping table, based on which TcrRenderView maps local peripheral input events to cloud input events.
`void`	`handleMotion(MotionEvent event)` Handle touch event.
`boolean`	`onCapturedPointerEvent(MotionEvent event)`
`protected void`	`onLayout(boolean changed, int left, int top, int right, int bottom)`
`abstract void`	`release()` Release the underlying resources of this view. You need to call this API to release the underlying resources if it is no longer needed, for example, when the `Activity` is to be destroyed.
`abstract void`	`setDisplayDebugView(boolean displayDebugView)` Set whether to display the debug view.
`void`	`setEnableInputDeviceHandle(boolean enableInputDeviceHandler)` Set whether to enable TcrRenderView to process the peripheral input events.
`abstract void`	`setEnableSuperResolution(boolean enableSuperResolution)` Set whether the video super-resolution capability should be enabled.
`void`	`setObserver(TcrRenderView.Observer observer)` Set the observer of this TcrRenderView instance.
`void`	`setOnTouchListener(View.OnTouchListener listener)` Set the listener for the touch events of the view.
`abstract void`	`setVideoRotation(TcrRenderView.VideoRotation rotation)` Set the rotation angle of the rendered video.
`abstract void`	`setVideoScaleType(TcrRenderView.ScaleType type)` Set the scaling type of the rendered video.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mRenderView
```
protected final View mRenderView
```
  - mTcrRenderViewType
```
protected final TcrRenderView.TcrRenderViewType mTcrRenderViewType
```
  - mObserver
```
protected TcrRenderView.Observer mObserver
```
- Constructor Detail
  - TcrRenderView
```
protected TcrRenderView(Context context,
                        TcrRenderView.TcrRenderViewType type,
                        TcrSession session)
```
    The constructor
    
    Parameters:
    
    context - The context of this view.
    
    type - The type of this view.
- Method Detail
  - createRenderView
```
protected abstract View createRenderView(TcrRenderView.TcrRenderViewType type)
```
    创建渲染视图
    
    Parameters:
    
    type - 渲染视图的类型
    
    Returns:
    
    视图
  - onLayout
```
protected void onLayout(boolean changed,
                        int left,
                        int top,
                        int right,
                        int bottom)
```
  - setOnTouchListener
```
public void setOnTouchListener(View.OnTouchListener listener)
```
    Set the listener for the touch events of the view. Generally, two default implementations provided by the SDK are used:
    1. PcTouchListener: Convert local screen touch events to mouse events on the cloud machine.
    2. MobileTouchListener: Map local screen touch events to touch events on the cloud machine.
  - release
```
public abstract void release()
```
    Release the underlying resources of this view.
    You need to call this API to release the underlying resources if it is no longer needed, for example, when the Activity is to be destroyed.
  - handleMotion
```
public void handleMotion(MotionEvent event)
```
    Handle touch event.
    This method will be useful in scenarios like the following: a virtual keyboard view is placed on top of the rendering view, and it is hoped that the buttons on the virtual keyboard view can be clicked while touching the rendering view, such as controlling a character to attack while moving in a mobile game. You can achieve this interactive effect like this:
    1. Place the virtual keyboard view above the level of the rendering view, with the same size.
    2. In the virtual keyboard view, at the same level as the button, create an empty view, named delegateView for example, that fills the virtual keyboard view in the layout.
    3. Listen to the OnTouchListener of delegateView, call this in onTouch() callback, and return true. For example:
```
       delegateView.setOnTouchListener(new OnTouchListener() {
            public boolean onTouch(View v, MotionEvent event) {
                tcrRenderView.handleMotion(event);
                return true;
            }
        });
 
```
    Parameters:
    
    event - The motion event.
  - setVideoRotation
```
public abstract void setVideoRotation(TcrRenderView.VideoRotation rotation)
```
    Set the rotation angle of the rendered video.
    
    Parameters:
    
    rotation - The rotation angle
  - setVideoScaleType
```
public abstract void setVideoScaleType(TcrRenderView.ScaleType type)
```
    Set the scaling type of the rendered video.
    If not set, the default scaling type is TcrRenderView.ScaleType.SCALE_ASPECT_FIT.
    
    Parameters:
    
    type - The scaling type
  - setEnableSuperResolution
```
public abstract void setEnableSuperResolution(boolean enableSuperResolution)
```
    Set whether the video super-resolution capability should be enabled.
    If enabled, the rendering quality will be improved, but the GPU and power consumption will increase, and the frame rate may decrease.
    
    Note that this method only works in api level 21 or above.
    
    Parameters:
    
    enableSuperResolution - true to enable SuperResolution, false otherwise.
  - setDisplayDebugView
```
public abstract void setDisplayDebugView(boolean displayDebugView)
```
    Set whether to display the debug view.
    The debug view shows the information such as performance data, version information, encoding type, key and touch information, etc.
    
    Parameters:
    
    displayDebugView - true to display the debug view, false otherwise.
  - getKeyCodeMapping
```
public java.util.Map getKeyCodeMapping(TcrRenderView.InputDeviceType inputDeviceType)
```
    Returns a mapping table, based on which TcrRenderView maps local peripheral input events to cloud input events.
    If the input device type is TcrRenderView.InputDeviceType.MOUSE, the returned map is of type HashMap<Integer, KeyType>. The key of the returned map refers to the keycodes defined in KeyEvent, and the value of the returned map refers to the enums defined in Mouse.KeyType.
    If the input device type is TcrRenderView.InputDeviceType.GAMEPAD or TcrRenderView.InputDeviceType.KEYBOARD, the returned map is of type HashMap<Integer, Integer>. The key of the returned map refers to the keycodes defined in KeyEvent, and the value of the returned map refers to the keycodes defined in WindowsKeyEvent.
    
    You can modify the returned map to customize the mapping.
    
    Parameters:
    
    inputDeviceType - The input device type.
    
    Returns:
    
    The returned Map.
  - setEnableInputDeviceHandle
```
public void setEnableInputDeviceHandle(boolean enableInputDeviceHandler)
```
    Set whether to enable TcrRenderView to process the peripheral input events.
    Setting this to true tells the TcrRenderView to process input device events automatically. This is the default behavior of TcrRenderView.
    
    Parameters:
    
    enableInputDeviceHandler - true to enable, false to disable.
  - dispatchKeyEvent
```
public boolean dispatchKeyEvent(KeyEvent event)
```
  - dispatchGenericMotionEvent
```
public boolean dispatchGenericMotionEvent(MotionEvent event)
```
  - onCapturedPointerEvent
```
public boolean onCapturedPointerEvent(MotionEvent event)
```
  - setObserver
```
public void setObserver(TcrRenderView.Observer observer)
```
    Set the observer of this TcrRenderView instance.
    
    Parameters:
    
    observer - The observer to be set.

Class TcrRenderView

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mRenderView

mTcrRenderViewType

mObserver

Constructor Detail

TcrRenderView

Method Detail

createRenderView

onLayout

setOnTouchListener

release

handleMotion

setVideoRotation

setVideoScaleType

setEnableSuperResolution

setDisplayDebugView

getKeyCodeMapping

setEnableInputDeviceHandle

dispatchKeyEvent

dispatchGenericMotionEvent

onCapturedPointerEvent

setObserver