Class CaptureBase

Base class wrapping common capture functionality

Inheritance

System.Object

CaptureBase

CaptureFromCamera

CaptureFromCamera360

CaptureFromCamera360ODS

CaptureFromScreen

CaptureFromTexture

Namespace: RenderHeads.Media.AVProMovieCapture

Assembly: cs.temp.dll.dll

Syntax

public class CaptureBase : MonoBehaviour

Fields

_androidUpdateMediaGallery

Declaration

protected bool _androidUpdateMediaGallery

Field Value

Type	Description
System.Boolean

_capturing

Declaration

protected bool _capturing

Field Value

Type	Description
System.Boolean

_fileInfo

Declaration

protected FileInfo _fileInfo

Field Value

Type	Description
FileInfo

_filePath

Declaration

protected string _filePath

Field Value

Type	Description
System.String

_finalFilePath

Declaration

protected string _finalFilePath

Field Value

Type	Description
System.String

_handle

Declaration

protected int _handle

Field Value

Type	Description
System.Int32

_isDirectX11

Declaration

protected bool _isDirectX11

Field Value

Type	Description
System.Boolean

_isTopDown

Declaration

protected bool _isTopDown

Field Value

Type	Description
System.Boolean

_motionBlur

Declaration

protected MotionBlur _motionBlur

Field Value

Type	Description
MotionBlur

_motionBlurCameras

Declaration

protected Camera[] _motionBlurCameras

Field Value

Type	Description
Camera[]

_motionBlurSamples

Declaration

protected int _motionBlurSamples

Field Value

Type	Description
System.Int32

_outputTarget

Declaration

protected OutputTarget _outputTarget

Field Value

Type	Description
OutputTarget

_paused

Declaration

protected bool _paused

Field Value

Type	Description
System.Boolean

_pixelFormat

Declaration

protected NativePlugin.PixelFormat _pixelFormat

Field Value

Type	Description
NativePlugin.PixelFormat

_renderAntiAliasing

Declaration

protected int _renderAntiAliasing

Field Value

Type	Description
System.Int32

_renderResolution

Declaration

protected CaptureBase.Resolution _renderResolution

Field Value

Type	Description
CaptureBase.Resolution

_renderSize

Declaration

protected Vector2 _renderSize

Field Value

Type	Description
Vector2

_sideBySideMaterial

Declaration

protected Material _sideBySideMaterial

Field Value

Type	Description
Material

_sideBySideTexture

Declaration

protected RenderTexture _sideBySideTexture

Field Value

Type	Description
RenderTexture

_sourceHeight

Declaration

protected int _sourceHeight

Field Value

Type	Description
System.Int32

_sourceWidth

Declaration

protected int _sourceWidth

Field Value

Type	Description
System.Int32

_supportTextureRecreate

Declaration

protected bool _supportTextureRecreate

Field Value

Type	Description
System.Boolean

_targetHeight

Declaration

protected int _targetHeight

Field Value

Type	Description
System.Int32

_targetWidth

Declaration

protected int _targetWidth

Field Value

Type	Description
System.Int32

_texture

Declaration

protected Texture2D _texture

Field Value

Type	Description
Texture2D

_Transparency

Declaration

protected Transparency _Transparency

Field Value

Type	Description
Transparency

_useMotionBlur

Declaration

protected bool _useMotionBlur

Field Value

Type	Description
System.Boolean

_useWaitForEndOfFrame

Declaration

protected bool _useWaitForEndOfFrame

Field Value

Type	Description
System.Boolean

_waitForEndOfFrame

Declaration

protected YieldInstruction _waitForEndOfFrame

Field Value

Type	Description
YieldInstruction

DefaultAudioCaptureDevicePriorityAndroid

Declaration

public static readonly string[] DefaultAudioCaptureDevicePriorityAndroid

Field Value

Type	Description
System.String[]

DefaultAudioCaptureDevicePriorityIOS

Declaration

public static readonly string[] DefaultAudioCaptureDevicePriorityIOS

Field Value

Type	Description
System.String[]

DefaultAudioCaptureDevicePriorityMacOS

Declaration

public static readonly string[] DefaultAudioCaptureDevicePriorityMacOS

Field Value

Type	Description
System.String[]

DefaultAudioCaptureDevicePriorityWindow

Declaration

public static readonly string[] DefaultAudioCaptureDevicePriorityWindow

Field Value

Type	Description
System.String[]

DefaultAudioCodecPriorityAndroid

Declaration

public static readonly string[] DefaultAudioCodecPriorityAndroid

Field Value

Type	Description
System.String[]

DefaultAudioCodecPriorityIOS

Declaration

public static readonly string[] DefaultAudioCodecPriorityIOS

Field Value

Type	Description
System.String[]

DefaultAudioCodecPriorityMacOS

Declaration

public static readonly string[] DefaultAudioCodecPriorityMacOS

Field Value

Type	Description
System.String[]

DefaultAudioCodecPriorityWindows

Declaration

public static readonly string[] DefaultAudioCodecPriorityWindows

Field Value

Type	Description
System.String[]

DefaultOutputFolderType

Declaration

public const CaptureBase.OutputPath DefaultOutputFolderType = CaptureBase.OutputPath.RelativeToProject

Field Value

Type	Description
CaptureBase.OutputPath

DefaultVideoCodecPriorityAndroid

Declaration

public static readonly string[] DefaultVideoCodecPriorityAndroid

Field Value

Type	Description
System.String[]

DefaultVideoCodecPriorityMacOS

Declaration

public static readonly string[] DefaultVideoCodecPriorityMacOS

Field Value

Type	Description
System.String[]

DefaultVideoCodecPriorityWindows

Declaration

public static readonly string[] DefaultVideoCodecPriorityWindows

Field Value

Type	Description
System.String[]

Properties

ActiveFilePaths

Declaration

public static HashSet<string> ActiveFilePaths { get; }

Property Value

Type	Description
HashSet<System.String>

AllowManualFileExtension

Declaration

public bool AllowManualFileExtension { get; set; }

Property Value

Type	Description
System.Boolean

AllowOfflineVSyncDisable

Declaration

public bool AllowOfflineVSyncDisable { get; set; }

Property Value

Type	Description
System.Boolean

AppendFilenameTimestamp

Declaration

public bool AppendFilenameTimestamp { get; set; }

Property Value

Type	Description
System.Boolean

AudioCaptureSource

Declaration

public AudioCaptureSource AudioCaptureSource { get; set; }

Property Value

Type	Description
AudioCaptureSource

AudioCodecPriorityMacOS

Declaration

public string[] AudioCodecPriorityMacOS { get; set; }

Property Value

Type	Description
System.String[]

AudioCodecPriorityWindows

Declaration

public string[] AudioCodecPriorityWindows { get; set; }

Property Value

Type	Description
System.String[]

BeginFinalFileWritingAction

Declaration

public Action<FileWritingHandler> BeginFinalFileWritingAction { get; set; }

Property Value

Type	Description
System.Action<FileWritingHandler>

CameraRenderAntiAliasing

Declaration

public int CameraRenderAntiAliasing { get; set; }

Property Value

Type	Description
System.Int32

CameraRenderCustomResolution

Declaration

public Vector2 CameraRenderCustomResolution { get; set; }

Property Value

Type	Description
Vector2

CameraRenderResolution

Declaration

public CaptureBase.Resolution CameraRenderResolution { get; set; }

Property Value

Type	Description
CaptureBase.Resolution

CaptureStats

Declaration

public CaptureStats CaptureStats { get; }

Property Value

Type	Description
CaptureStats

CompletedFileWritingAction

Declaration

public Action<FileWritingHandler> CompletedFileWritingAction { get; set; }

Property Value

Type	Description
System.Action<FileWritingHandler>

FilenameExtension

Declaration

public string FilenameExtension { get; set; }

Property Value

Type	Description
System.String

FilenamePrefix

Declaration

public string FilenamePrefix { get; set; }

Property Value

Type	Description
System.String

FlipVertically

Declaration

public bool FlipVertically { get; set; }

Property Value

Type	Description
System.Boolean

ForceAudioInputDeviceIndex

Declaration

public int ForceAudioInputDeviceIndex { get; set; }

Property Value

Type	Description
System.Int32

FrameRate

Declaration

public float FrameRate { get; set; }

Property Value

Type	Description
System.Single

FrameUpdate

Declaration

public CaptureBase.FrameUpdateMode FrameUpdate { get; set; }

Property Value

Type	Description
CaptureBase.FrameUpdateMode

ImageSequenceStartFrame

Declaration

public int ImageSequenceStartFrame { get; set; }

Property Value

Type	Description
System.Int32

ImageSequenceZeroDigits

Declaration

public int ImageSequenceZeroDigits { get; set; }

Property Value

Type	Description
System.Int32

IsRealTime

Declaration

public bool IsRealTime { get; set; }

Property Value

Type	Description
System.Boolean

LastFilePath

Declaration

public string LastFilePath { get; }

Property Value

Type	Description
System.String

LastFileSaved

Declaration

public static string LastFileSaved { get; set; }

Property Value

Type	Description
System.String

LogCaptureStartStop

Declaration

public bool LogCaptureStartStop { get; set; }

Property Value

Type	Description
System.Boolean

ManualAudioChannelCount

Declaration

public int ManualAudioChannelCount { get; set; }

Property Value

Type	Description
System.Int32

ManualAudioSampleRate

Declaration

public int ManualAudioSampleRate { get; set; }

Property Value

Type	Description
System.Int32

MotionBlur

Declaration

public MotionBlur MotionBlur { get; set; }

Property Value

Type	Description
MotionBlur

MotionBlurCameras

Declaration

public Camera[] MotionBlurCameras { get; set; }

Property Value

Type	Description
Camera[]

MotionBlurSamples

Declaration

public int MotionBlurSamples { get; set; }

Property Value

Type	Description
System.Int32

NamedPipePath

Declaration

public string NamedPipePath { get; set; }

Property Value

Type	Description
System.String

NativeForceAudioCodecIndex

Declaration

public int NativeForceAudioCodecIndex { get; set; }

Property Value

Type	Description
System.Int32

NativeForceVideoCodecIndex

Declaration

public int NativeForceVideoCodecIndex { get; set; }

Property Value

Type	Description
System.Int32

NativeImageSequenceFormat

Declaration

public ImageSequenceFormat NativeImageSequenceFormat { get; set; }

Property Value

Type	Description
ImageSequenceFormat

OnCaptureStart

Declaration

public UnityEvent OnCaptureStart { get; }

Property Value

Type	Description
UnityEvent

OutputFolder

Declaration

public CaptureBase.OutputPath OutputFolder { get; set; }

Property Value

Type	Description
CaptureBase.OutputPath

OutputFolderPath

Declaration

public string OutputFolderPath { get; set; }

Property Value

Type	Description
System.String

OutputTarget

Declaration

public OutputTarget OutputTarget { get; set; }

Property Value

Type	Description
OutputTarget

PauseCaptureOnAppPause

Declaration

public bool PauseCaptureOnAppPause { get; set; }

Property Value

Type	Description
System.Boolean

PersistAcrossSceneLoads

Declaration

public bool PersistAcrossSceneLoads { get; set; }

Property Value

Type	Description
System.Boolean

ResolutionDownScale

Declaration

public CaptureBase.DownScale ResolutionDownScale { get; set; }

Property Value

Type	Description
CaptureBase.DownScale

ResolutionDownscaleCustom

Declaration

public Vector2 ResolutionDownscaleCustom { get; set; }

Property Value

Type	Description
Vector2

SelectedAudioCodec

Declaration

public Codec SelectedAudioCodec { get; }

Property Value

Type	Description
Codec

SelectedAudioInputDevice

Declaration

public Device SelectedAudioInputDevice { get; }

Property Value

Type	Description
Device

SelectedVideoCodec

Declaration

public Codec SelectedVideoCodec { get; }

Property Value

Type	Description
Codec

StartDelay

Declaration

public StartDelayMode StartDelay { get; set; }

Property Value

Type	Description
StartDelayMode

StartDelaySeconds

Declaration

public float StartDelaySeconds { get; set; }

Property Value

Type	Description
System.Single

StartTrigger

Declaration

public StartTriggerMode StartTrigger { get; set; }

Property Value

Type	Description
StartTriggerMode

StopAfterFramesElapsed

Declaration

public int StopAfterFramesElapsed { get; set; }

Property Value

Type	Description
System.Int32

StopAfterSecondsElapsed

Declaration

public float StopAfterSecondsElapsed { get; set; }

Property Value

Type	Description
System.Single

StopMode

Declaration

public StopMode StopMode { get; set; }

Property Value

Type	Description
StopMode

SupportTextureRecreate

Declaration

public bool SupportTextureRecreate { get; set; }

Property Value

Type	Description
System.Boolean

TimelapseScale

Declaration

public int TimelapseScale { get; set; }

Property Value

Type	Description
System.Int32

Transparency

Declaration

public Transparency Transparency { get; }

Property Value

Type	Description
Transparency

UnityAudioCapture

Declaration

public UnityAudioCapture UnityAudioCapture { get; set; }

Property Value

Type	Description
UnityAudioCapture

UseMotionBlur

Declaration

public bool UseMotionBlur { get; set; }

Property Value

Type	Description
System.Boolean

UseWaitForEndOfFrame

Declaration

public bool UseWaitForEndOfFrame { get; set; }

Property Value

Type	Description
System.Boolean

VideoCodecPriorityMacOS

Declaration

public string[] VideoCodecPriorityMacOS { get; set; }

Property Value

Type	Description
System.String[]

VideoCodecPriorityWindows

Declaration

public string[] VideoCodecPriorityWindows { get; set; }

Property Value

Type	Description
System.String[]

WriteOrientationMetadata

Declaration

public bool WriteOrientationMetadata { get; set; }

Property Value

Type	Description
System.Boolean

Methods

ApplyPostOperations(String, VideoEncoderHints, String)

Declaration

protected void ApplyPostOperations(string filePath, VideoEncoderHints hints, string finalFilePath)

Parameters

Type	Name	Description
System.String	filePath
VideoEncoderHints	hints
System.String	finalFilePath

Awake()

Declaration

protected virtual void Awake()

CancelCapture()

Declaration

public void CancelCapture()

CanContinue()

Declaration

protected bool CanContinue()

Returns

Type	Description
System.Boolean

CanOutputFrame()

Declaration

protected bool CanOutputFrame()

Returns

Type	Description
System.Boolean

DeleteCapture(OutputTarget, String)

Declaration

public static void DeleteCapture(OutputTarget outputTarget, string path)

Parameters

Type	Name	Description
OutputTarget	outputTarget
System.String	path

EncodeAudio(NativeArray<Single>)

Declaration

public void EncodeAudio(NativeArray<float> audioData)

Parameters

Type	Name	Description
NativeArray<System.Single>	audioData

EncodeAudio(Single[])

Declaration

public void EncodeAudio(float[] audioData)

Parameters

Type	Name	Description
System.Single[]	audioData

EncodePointer(IntPtr)

Declaration

public virtual void EncodePointer(IntPtr ptr)

Parameters

Type	Name	Description
System.IntPtr	ptr

EncodeTexture(Texture2D)

Declaration

protected void EncodeTexture(Texture2D texture)

Parameters

Type	Name	Description
Texture2D	texture

EncodeUnityAudio()

Declaration

protected void EncodeUnityAudio()

FindOrCreateUnityAudioCapture(Boolean)

Declaration

public UnityAudioCapture FindOrCreateUnityAudioCapture(bool logWarnings)

Parameters

Type	Name	Description
System.Boolean	logWarnings

Returns

Type	Description
UnityAudioCapture

GenerateFilename()

Declaration

protected void GenerateFilename()

GenerateTimestampedFilename(String, String)

Declaration

protected virtual string GenerateTimestampedFilename(string filenamePrefix, string filenameExtension)

Parameters

Type	Name	Description
System.String	filenamePrefix
System.String	filenameExtension

Returns

Type	Description
System.String

GetCameraAntiAliasingLevel(Camera)

Declaration

protected int GetCameraAntiAliasingLevel(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Returns

Type	Description
System.Int32

GetCaptureFileSize()

Declaration

public long GetCaptureFileSize()

Returns

Type	Description
System.Int64

GetCurrentPlatform()

Declaration

protected static NativePlugin.Platform GetCurrentPlatform()

Returns

Type	Description
NativePlugin.Platform

GetEncoderHints(NativePlugin.Platform)

Declaration

public EncoderHints GetEncoderHints(NativePlugin.Platform platform = NativePlugin.Platform.Current)

Parameters

Type	Name	Description
NativePlugin.Platform	platform

Returns

Type	Description
EncoderHints

GetPreviewTexture()

Declaration

public virtual Texture GetPreviewTexture()

Returns

Type	Description
Texture

GetProgress()

Declaration

public float GetProgress()

Returns

Type	Description
System.Single

GetRecordingHeight()

Declaration

public int GetRecordingHeight()

Returns

Type	Description
System.Int32

GetRecordingResolution(Int32, Int32, CaptureBase.DownScale, Vector2)

Declaration

public static Vector2 GetRecordingResolution(int width, int height, CaptureBase.DownScale downscale, Vector2 maxVideoSize)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
CaptureBase.DownScale	downscale
Vector2	maxVideoSize

Returns

Type	Description
Vector2

GetRecordingWidth()

Declaration

public int GetRecordingWidth()

Returns

Type	Description
System.Int32

GetResolution(CaptureBase.Resolution, ref Int32, ref Int32)

Declaration

public static void GetResolution(CaptureBase.Resolution res, ref int width, ref int height)

Parameters

Type	Name	Description
CaptureBase.Resolution	res
System.Int32	width
System.Int32	height

GetSecondsPerCaptureFrame()

Declaration

protected float GetSecondsPerCaptureFrame()

Returns

Type	Description
System.Single

GetSideBySideTexture()

Declaration

public virtual Texture GetSideBySideTexture()

Returns

Type	Description
Texture

HasExtension(String, String)

Declaration

protected static bool HasExtension(string path, string extension)

Parameters

Type	Name	Description
System.String	path
System.String	extension

Returns

Type	Description
System.Boolean

InitialiseSideBySideTransparency(Int32, Int32, Boolean, Int32)

Declaration

protected bool InitialiseSideBySideTransparency(int width, int height, bool screenFlip = false, int antiAliasing = 1)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
System.Boolean	screenFlip
System.Int32	antiAliasing

Returns

Type	Description
System.Boolean

IsCapturing()

Declaration

public bool IsCapturing()

Returns

Type	Description
System.Boolean

IsPaused()

Declaration

public bool IsPaused()

Returns

Type	Description
System.Boolean

IsPrepared()

Declaration

public bool IsPrepared()

Returns

Type	Description
System.Boolean

IsStartCaptureQueued()

Declaration

public bool IsStartCaptureQueued()

Returns

Type	Description
System.Boolean

IsStartDelayComplete()

Declaration

protected bool IsStartDelayComplete()

Returns

Type	Description
System.Boolean

IsStopTimeReached()

Declaration

protected bool IsStopTimeReached()

Returns

Type	Description
System.Boolean

IsUsingMotionBlur()

Declaration

protected bool IsUsingMotionBlur()

Returns

Type	Description
System.Boolean

IsUsingUnityAudioComponent()

Declaration

protected bool IsUsingUnityAudioComponent()

Returns

Type	Description
System.Boolean

NextMultipleOf4(Int32)

Declaration

protected static int NextMultipleOf4(int value)

Parameters

Type	Name	Description
System.Int32	value

Returns

Type	Description
System.Int32

OnDestroy()

Declaration

public virtual void OnDestroy()

PauseCapture()

Declaration

public void PauseCapture()

PrepareCapture()

Declaration

public virtual bool PrepareCapture()

Returns

Type	Description
System.Boolean

PreUpdateFrame()

Declaration

public virtual void PreUpdateFrame()

QueueStartCapture()

Declaration

public void QueueStartCapture()

RenderThreadEvent(NativePlugin.PluginEvent)

Declaration

protected void RenderThreadEvent(NativePlugin.PluginEvent renderEvent)

Parameters

Type	Name	Description
NativePlugin.PluginEvent	renderEvent

RenormTimer()

Declaration

protected void RenormTimer()

ResetFPS()

Declaration

protected void ResetFPS()

ResumeCapture()

Declaration

public void ResumeCapture()

SelectAudioCodec()

Declaration

public Codec SelectAudioCodec()

Returns

Type	Description
Codec

SelectAudioInputDevice()

Declaration

public Device SelectAudioInputDevice()

Returns

Type	Description
Device

SelectRecordingResolution(Int32, Int32)

Declaration

public void SelectRecordingResolution(int width, int height)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height

SelectVideoCodec(Boolean)

Declaration

public Codec SelectVideoCodec(bool isStartingCapture = false)

Parameters

Type	Name	Description
System.Boolean	isStartingCapture

Returns

Type	Description
Codec

SetEncoderHints(EncoderHints, NativePlugin.Platform)

Declaration

public void SetEncoderHints(EncoderHints hints, NativePlugin.Platform platform = NativePlugin.Platform.Current)

Parameters

Type	Name	Description
EncoderHints	hints
NativePlugin.Platform	platform

SetMicrophoneRecordingHint(Boolean, MicrophoneRecordingOptions)

Hints to the system that we want to capture audio from the microphone.

iOS
Call this with enabled = true before you begin recording to prevent any unwanted stalls or pops when the recording begins due to changing the audio session. Call with enabled = false to restore the audio session.

Declaration

public void SetMicrophoneRecordingHint(bool enabled, MicrophoneRecordingOptions options = MicrophoneRecordingOptions.Defaults)

Parameters

Type	Name	Description
System.Boolean	enabled	Enables or disables audio recording from the microphone
MicrophoneRecordingOptions	options	Options to apply when enabling or disabling audio recording

Start()

Declaration

public virtual void Start()

StartCapture()

Declaration

public bool StartCapture()

Returns

Type	Description
System.Boolean

StopCapture(Boolean, Boolean, Boolean)

Declaration

public virtual void StopCapture(bool skipPendingFrames = false, bool ignorePendingFileWrites = false, bool deleteCapture = false)

Parameters

Type	Name	Description
System.Boolean	skipPendingFrames
System.Boolean	ignorePendingFileWrites
System.Boolean	deleteCapture

TickFrameTimer()

Declaration

protected void TickFrameTimer()

UnprepareCapture()

Declaration

public virtual void UnprepareCapture()

UpdateForSideBySideTransparency(Texture, Boolean, Int32)

Declaration

protected RenderTexture UpdateForSideBySideTransparency(Texture sourceTexture, bool screenFlip = false, int antiAliasing = 1)

Parameters

Type	Name	Description
Texture	sourceTexture
System.Boolean	screenFlip
System.Int32	antiAliasing

Returns

Type	Description
RenderTexture

UpdateFPS()

Declaration

public void UpdateFPS()

UpdateFrame()

Declaration

public virtual void UpdateFrame()

UpdateInjectionOptions(StereoPacking, SphericalVideoLayout)

Declaration

protected void UpdateInjectionOptions(StereoPacking stereoPacking, SphericalVideoLayout sphericalVideoLayout)

Parameters

Type	Name	Description
StereoPacking	stereoPacking
SphericalVideoLayout	sphericalVideoLayout

UpdateMediaGallery(String)

Declaration

public static void UpdateMediaGallery(string videoFilePath)

Parameters

Type	Name	Description
System.String	videoFilePath